@emilgroup/document-sdk-node 1.39.1-beta.0 → 1.39.1-beta.2

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.
@@ -17,6 +17,9 @@ common.ts
17
17
  configuration.ts
18
18
  git_push.sh
19
19
  index.ts
20
+ models/base64-metadata-class.ts
21
+ models/convert-to-base64-request-dto.ts
22
+ models/convert-to-base64-response-class.ts
20
23
  models/create-doc-template-request-dto.ts
21
24
  models/create-doc-template-response-class.ts
22
25
  models/create-document-request-dto.ts
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-node@1.39.1-beta.0 --save
20
+ npm install @emilgroup/document-sdk-node@1.39.1-beta.2 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk-node@1.39.1-beta.0
24
+ yarn add @emilgroup/document-sdk-node@1.39.1-beta.2
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { ConvertToBase64RequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { ConvertToBase64ResponseClass } from '../models';
27
+ // @ts-ignore
24
28
  import { CreateDocumentRequestDto } from '../models';
25
29
  // @ts-ignore
26
30
  import { CreateDocumentSyncResponseClass } from '../models';
@@ -50,6 +54,57 @@ const FormData = require('form-data');
50
54
  */
51
55
  export const DocumentsApiAxiosParamCreator = function (configuration?: Configuration) {
52
56
  return {
57
+ /**
58
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
59
+ * @summary Convert document to base64
60
+ * @param {string} code Document code
61
+ * @param {ConvertToBase64RequestDto} convertToBase64RequestDto
62
+ * @param {string} [authorization] Bearer Token
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ */
66
+ convertToBase64: async (code: string, convertToBase64RequestDto: ConvertToBase64RequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
67
+ // verify required parameter 'code' is not null or undefined
68
+ assertParamExists('convertToBase64', 'code', code)
69
+ // verify required parameter 'convertToBase64RequestDto' is not null or undefined
70
+ assertParamExists('convertToBase64', 'convertToBase64RequestDto', convertToBase64RequestDto)
71
+ const localVarPath = `/documentservice/v1/documents/{code}/base64`
72
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
73
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
74
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
75
+ let baseOptions;
76
+ let baseAccessToken;
77
+ if (configuration) {
78
+ baseOptions = configuration.baseOptions;
79
+ baseAccessToken = configuration.accessToken;
80
+ }
81
+
82
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
83
+ const localVarHeaderParameter = {} as any;
84
+ const localVarQueryParameter = {} as any;
85
+
86
+ // authentication bearer required
87
+ // http bearer authentication required
88
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
89
+
90
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
91
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
92
+ }
93
+
94
+
95
+
96
+ localVarHeaderParameter['Content-Type'] = 'application/json';
97
+
98
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
99
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
100
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
101
+ localVarRequestOptions.data = serializeDataIfNeeded(convertToBase64RequestDto, localVarRequestOptions, configuration)
102
+
103
+ return {
104
+ url: toPathString(localVarUrlObj),
105
+ options: localVarRequestOptions,
106
+ };
107
+ },
53
108
  /**
54
109
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
55
110
  * @summary Create the document
@@ -369,7 +424,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
369
424
  };
370
425
  },
371
426
  /**
372
- * 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\"
427
+ * 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\"
373
428
  * @summary Save external document
374
429
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
375
430
  * @param {string} [authorization] Bearer Token
@@ -476,6 +531,19 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
476
531
  export const DocumentsApiFp = function(configuration?: Configuration) {
477
532
  const localVarAxiosParamCreator = DocumentsApiAxiosParamCreator(configuration)
478
533
  return {
534
+ /**
535
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
536
+ * @summary Convert document to base64
537
+ * @param {string} code Document code
538
+ * @param {ConvertToBase64RequestDto} convertToBase64RequestDto
539
+ * @param {string} [authorization] Bearer Token
540
+ * @param {*} [options] Override http request option.
541
+ * @throws {RequiredError}
542
+ */
543
+ async convertToBase64(code: string, convertToBase64RequestDto: ConvertToBase64RequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConvertToBase64ResponseClass>> {
544
+ const localVarAxiosArgs = await localVarAxiosParamCreator.convertToBase64(code, convertToBase64RequestDto, authorization, options);
545
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
546
+ },
479
547
  /**
480
548
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
481
549
  * @summary Create the document
@@ -557,7 +625,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
557
625
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
558
626
  },
559
627
  /**
560
- * 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\"
628
+ * 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\"
561
629
  * @summary Save external document
562
630
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
563
631
  * @param {string} [authorization] Bearer Token
@@ -591,6 +659,18 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
591
659
  export const DocumentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
592
660
  const localVarFp = DocumentsApiFp(configuration)
593
661
  return {
662
+ /**
663
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
664
+ * @summary Convert document to base64
665
+ * @param {string} code Document code
666
+ * @param {ConvertToBase64RequestDto} convertToBase64RequestDto
667
+ * @param {string} [authorization] Bearer Token
668
+ * @param {*} [options] Override http request option.
669
+ * @throws {RequiredError}
670
+ */
671
+ convertToBase64(code: string, convertToBase64RequestDto: ConvertToBase64RequestDto, authorization?: string, options?: any): AxiosPromise<ConvertToBase64ResponseClass> {
672
+ return localVarFp.convertToBase64(code, convertToBase64RequestDto, authorization, options).then((request) => request(axios, basePath));
673
+ },
594
674
  /**
595
675
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
596
676
  * @summary Create the document
@@ -666,7 +746,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
666
746
  return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
667
747
  },
668
748
  /**
669
- * 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\"
749
+ * 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\"
670
750
  * @summary Save external document
671
751
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
672
752
  * @param {string} [authorization] Bearer Token
@@ -691,6 +771,34 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
691
771
  };
692
772
  };
693
773
 
774
+ /**
775
+ * Request parameters for convertToBase64 operation in DocumentsApi.
776
+ * @export
777
+ * @interface DocumentsApiConvertToBase64Request
778
+ */
779
+ export interface DocumentsApiConvertToBase64Request {
780
+ /**
781
+ * Document code
782
+ * @type {string}
783
+ * @memberof DocumentsApiConvertToBase64
784
+ */
785
+ readonly code: string
786
+
787
+ /**
788
+ *
789
+ * @type {ConvertToBase64RequestDto}
790
+ * @memberof DocumentsApiConvertToBase64
791
+ */
792
+ readonly convertToBase64RequestDto: ConvertToBase64RequestDto
793
+
794
+ /**
795
+ * Bearer Token
796
+ * @type {string}
797
+ * @memberof DocumentsApiConvertToBase64
798
+ */
799
+ readonly authorization?: string
800
+ }
801
+
694
802
  /**
695
803
  * Request parameters for createDocument operation in DocumentsApi.
696
804
  * @export
@@ -929,6 +1037,18 @@ export interface DocumentsApiUpdateDocumentRequest {
929
1037
  * @extends {BaseAPI}
930
1038
  */
931
1039
  export class DocumentsApi extends BaseAPI {
1040
+ /**
1041
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
1042
+ * @summary Convert document to base64
1043
+ * @param {DocumentsApiConvertToBase64Request} requestParameters Request parameters.
1044
+ * @param {*} [options] Override http request option.
1045
+ * @throws {RequiredError}
1046
+ * @memberof DocumentsApi
1047
+ */
1048
+ public convertToBase64(requestParameters: DocumentsApiConvertToBase64Request, options?: AxiosRequestConfig) {
1049
+ return DocumentsApiFp(this.configuration).convertToBase64(requestParameters.code, requestParameters.convertToBase64RequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1050
+ }
1051
+
932
1052
  /**
933
1053
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
934
1054
  * @summary Create the document
@@ -1002,7 +1122,7 @@ export class DocumentsApi extends BaseAPI {
1002
1122
  }
1003
1123
 
1004
1124
  /**
1005
- * 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\"
1125
+ * 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\"
1006
1126
  * @summary Save external document
1007
1127
  * @param {DocumentsApiSaveExternalDocumentRequest} requestParameters Request parameters.
1008
1128
  * @param {*} [options] Override http request option.
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
50
  var __generator = (this && this.__generator) || function (thisArg, body) {
51
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -74,15 +74,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
74
74
  if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
75
  }
76
76
  };
77
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
78
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
79
- if (ar || !(i in from)) {
80
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
81
- ar[i] = from[i];
82
- }
83
- }
84
- return to.concat(ar || Array.prototype.slice.call(from));
85
- };
86
77
  var __importDefault = (this && this.__importDefault) || function (mod) {
87
78
  return (mod && mod.__esModule) ? mod : { "default": mod };
88
79
  };
@@ -111,14 +102,10 @@ var DefaultApiAxiosParamCreator = function (configuration) {
111
102
  * @param {*} [options] Override http request option.
112
103
  * @throws {RequiredError}
113
104
  */
114
- check: function () {
115
- var args_1 = [];
116
- for (var _i = 0; _i < arguments.length; _i++) {
117
- args_1[_i] = arguments[_i];
118
- }
119
- return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
105
+ check: function (options) {
106
+ if (options === void 0) { options = {}; }
107
+ return __awaiter(_this, void 0, void 0, function () {
120
108
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
121
- if (options === void 0) { options = {}; }
122
109
  return __generator(this, function (_a) {
123
110
  localVarPath = "/documentservice/health";
124
111
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
50
  var __generator = (this && this.__generator) || function (thisArg, body) {
51
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -74,15 +74,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
74
74
  if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
75
  }
76
76
  };
77
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
78
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
79
- if (ar || !(i in from)) {
80
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
81
- ar[i] = from[i];
82
- }
83
- }
84
- return to.concat(ar || Array.prototype.slice.call(from));
85
- };
86
77
  var __importDefault = (this && this.__importDefault) || function (mod) {
87
78
  return (mod && mod.__esModule) ? mod : { "default": mod };
88
79
  };
@@ -113,14 +104,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
113
104
  * @param {*} [options] Override http request option.
114
105
  * @throws {RequiredError}
115
106
  */
116
- createDocTemplate: function (createDocTemplateRequestDto_1, authorization_1) {
117
- var args_1 = [];
118
- for (var _i = 2; _i < arguments.length; _i++) {
119
- args_1[_i - 2] = arguments[_i];
120
- }
121
- return __awaiter(_this, __spreadArray([createDocTemplateRequestDto_1, authorization_1], args_1, true), void 0, function (createDocTemplateRequestDto, authorization, options) {
107
+ createDocTemplate: function (createDocTemplateRequestDto, authorization, options) {
108
+ if (options === void 0) { options = {}; }
109
+ return __awaiter(_this, void 0, void 0, function () {
122
110
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
123
- if (options === void 0) { options = {}; }
124
111
  return __generator(this, function (_a) {
125
112
  switch (_a.label) {
126
113
  case 0:
@@ -166,14 +153,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
166
153
  * @param {*} [options] Override http request option.
167
154
  * @throws {RequiredError}
168
155
  */
169
- deleteDocTemplate: function (id_1, authorization_1) {
170
- var args_1 = [];
171
- for (var _i = 2; _i < arguments.length; _i++) {
172
- args_1[_i - 2] = arguments[_i];
173
- }
174
- return __awaiter(_this, __spreadArray([id_1, authorization_1], args_1, true), void 0, function (id, authorization, options) {
156
+ deleteDocTemplate: function (id, authorization, options) {
157
+ if (options === void 0) { options = {}; }
158
+ return __awaiter(_this, void 0, void 0, function () {
175
159
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
176
- if (options === void 0) { options = {}; }
177
160
  return __generator(this, function (_a) {
178
161
  switch (_a.label) {
179
162
  case 0:
@@ -219,14 +202,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
219
202
  * @param {*} [options] Override http request option.
220
203
  * @throws {RequiredError}
221
204
  */
222
- getDocTemplate: function (id_1, authorization_1, expand_1) {
223
- var args_1 = [];
224
- for (var _i = 3; _i < arguments.length; _i++) {
225
- args_1[_i - 3] = arguments[_i];
226
- }
227
- return __awaiter(_this, __spreadArray([id_1, authorization_1, expand_1], args_1, true), void 0, function (id, authorization, expand, options) {
205
+ getDocTemplate: function (id, authorization, expand, options) {
206
+ if (options === void 0) { options = {}; }
207
+ return __awaiter(_this, void 0, void 0, function () {
228
208
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
229
- if (options === void 0) { options = {}; }
230
209
  return __generator(this, function (_a) {
231
210
  switch (_a.label) {
232
211
  case 0:
@@ -279,14 +258,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
279
258
  * @param {*} [options] Override http request option.
280
259
  * @throws {RequiredError}
281
260
  */
282
- listDocTemplates: function (authorization_1, pageSize_1, pageToken_1, filter_1, search_1, order_1, expand_1) {
283
- var args_1 = [];
284
- for (var _i = 7; _i < arguments.length; _i++) {
285
- args_1[_i - 7] = arguments[_i];
286
- }
287
- return __awaiter(_this, __spreadArray([authorization_1, pageSize_1, pageToken_1, filter_1, search_1, order_1, expand_1], args_1, true), void 0, function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
261
+ listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
262
+ if (options === void 0) { options = {}; }
263
+ return __awaiter(_this, void 0, void 0, function () {
288
264
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
289
- if (options === void 0) { options = {}; }
290
265
  return __generator(this, function (_a) {
291
266
  switch (_a.label) {
292
267
  case 0:
@@ -347,14 +322,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
347
322
  * @param {*} [options] Override http request option.
348
323
  * @throws {RequiredError}
349
324
  */
350
- updateDocTemplate: function (id_1, updateDocTemplateRequestDto_1, authorization_1) {
351
- var args_1 = [];
352
- for (var _i = 3; _i < arguments.length; _i++) {
353
- args_1[_i - 3] = arguments[_i];
354
- }
355
- return __awaiter(_this, __spreadArray([id_1, updateDocTemplateRequestDto_1, authorization_1], args_1, true), void 0, function (id, updateDocTemplateRequestDto, authorization, options) {
325
+ updateDocTemplate: function (id, updateDocTemplateRequestDto, authorization, options) {
326
+ if (options === void 0) { options = {}; }
327
+ return __awaiter(_this, void 0, void 0, function () {
356
328
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
357
- if (options === void 0) { options = {}; }
358
329
  return __generator(this, function (_a) {
359
330
  switch (_a.label) {
360
331
  case 0:
@@ -12,6 +12,8 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { ConvertToBase64RequestDto } from '../models';
16
+ import { ConvertToBase64ResponseClass } from '../models';
15
17
  import { CreateDocumentRequestDto } from '../models';
16
18
  import { CreateDocumentSyncResponseClass } from '../models';
17
19
  import { CreatePresignedPostRequestDto } from '../models';
@@ -27,6 +29,16 @@ import { UpdateDocumentResponseClass } from '../models';
27
29
  * @export
28
30
  */
29
31
  export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
32
+ /**
33
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
34
+ * @summary Convert document to base64
35
+ * @param {string} code Document code
36
+ * @param {ConvertToBase64RequestDto} convertToBase64RequestDto
37
+ * @param {string} [authorization] Bearer Token
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ convertToBase64: (code: string, convertToBase64RequestDto: ConvertToBase64RequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
30
42
  /**
31
43
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
32
44
  * @summary Create the document
@@ -63,7 +75,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
63
75
  * @param {*} [options] Override http request option.
64
76
  * @throws {RequiredError}
65
77
  */
66
- getDocumentDownloadUrl: (code: string, authorization?: string, contentDisposition?: "attachment" | "inline", options?: AxiosRequestConfig) => Promise<RequestArgs>;
78
+ getDocumentDownloadUrl: (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
67
79
  /**
68
80
  * This will return a presigned URL for a random S3 key
69
81
  * @summary Fetches a presigned URL for a S3 key
@@ -73,7 +85,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
73
85
  * @param {*} [options] Override http request option.
74
86
  * @throws {RequiredError}
75
87
  */
76
- getSignedS3keyUrl: (s3Key: string, authorization?: string, contentDisposition?: "attachment" | "inline", options?: AxiosRequestConfig) => Promise<RequestArgs>;
88
+ getSignedS3keyUrl: (s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
89
  /**
78
90
  * 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\"
79
91
  * @summary List documents
@@ -90,7 +102,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
90
102
  */
91
103
  listDocuments: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
92
104
  /**
93
- * 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\"
105
+ * 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\"
94
106
  * @summary Save external document
95
107
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
96
108
  * @param {string} [authorization] Bearer Token
@@ -114,6 +126,16 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
114
126
  * @export
115
127
  */
116
128
  export declare const DocumentsApiFp: (configuration?: Configuration) => {
129
+ /**
130
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
131
+ * @summary Convert document to base64
132
+ * @param {string} code Document code
133
+ * @param {ConvertToBase64RequestDto} convertToBase64RequestDto
134
+ * @param {string} [authorization] Bearer Token
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ */
138
+ convertToBase64(code: string, convertToBase64RequestDto: ConvertToBase64RequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConvertToBase64ResponseClass>>;
117
139
  /**
118
140
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
119
141
  * @summary Create the document
@@ -150,7 +172,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
150
172
  * @param {*} [options] Override http request option.
151
173
  * @throws {RequiredError}
152
174
  */
153
- getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: "attachment" | "inline", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>>;
175
+ getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>>;
154
176
  /**
155
177
  * This will return a presigned URL for a random S3 key
156
178
  * @summary Fetches a presigned URL for a S3 key
@@ -160,7 +182,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
160
182
  * @param {*} [options] Override http request option.
161
183
  * @throws {RequiredError}
162
184
  */
163
- getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: "attachment" | "inline", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignedS3KeyUrlResponseClass>>;
185
+ getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignedS3KeyUrlResponseClass>>;
164
186
  /**
165
187
  * 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\"
166
188
  * @summary List documents
@@ -177,7 +199,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
177
199
  */
178
200
  listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
179
201
  /**
180
- * 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\"
202
+ * 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\"
181
203
  * @summary Save external document
182
204
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
183
205
  * @param {string} [authorization] Bearer Token
@@ -201,6 +223,16 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
201
223
  * @export
202
224
  */
203
225
  export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
226
+ /**
227
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
228
+ * @summary Convert document to base64
229
+ * @param {string} code Document code
230
+ * @param {ConvertToBase64RequestDto} convertToBase64RequestDto
231
+ * @param {string} [authorization] Bearer Token
232
+ * @param {*} [options] Override http request option.
233
+ * @throws {RequiredError}
234
+ */
235
+ convertToBase64(code: string, convertToBase64RequestDto: ConvertToBase64RequestDto, authorization?: string, options?: any): AxiosPromise<ConvertToBase64ResponseClass>;
204
236
  /**
205
237
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
206
238
  * @summary Create the document
@@ -237,7 +269,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
237
269
  * @param {*} [options] Override http request option.
238
270
  * @throws {RequiredError}
239
271
  */
240
- getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: "attachment" | "inline", options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass>;
272
+ getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass>;
241
273
  /**
242
274
  * This will return a presigned URL for a random S3 key
243
275
  * @summary Fetches a presigned URL for a S3 key
@@ -247,7 +279,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
247
279
  * @param {*} [options] Override http request option.
248
280
  * @throws {RequiredError}
249
281
  */
250
- getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: "attachment" | "inline", options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass>;
282
+ getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass>;
251
283
  /**
252
284
  * 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\"
253
285
  * @summary List documents
@@ -264,7 +296,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
264
296
  */
265
297
  listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
266
298
  /**
267
- * 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\"
299
+ * 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\"
268
300
  * @summary Save external document
269
301
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
270
302
  * @param {string} [authorization] Bearer Token
@@ -283,6 +315,31 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
283
315
  */
284
316
  updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocumentResponseClass>;
285
317
  };
318
+ /**
319
+ * Request parameters for convertToBase64 operation in DocumentsApi.
320
+ * @export
321
+ * @interface DocumentsApiConvertToBase64Request
322
+ */
323
+ export interface DocumentsApiConvertToBase64Request {
324
+ /**
325
+ * Document code
326
+ * @type {string}
327
+ * @memberof DocumentsApiConvertToBase64
328
+ */
329
+ readonly code: string;
330
+ /**
331
+ *
332
+ * @type {ConvertToBase64RequestDto}
333
+ * @memberof DocumentsApiConvertToBase64
334
+ */
335
+ readonly convertToBase64RequestDto: ConvertToBase64RequestDto;
336
+ /**
337
+ * Bearer Token
338
+ * @type {string}
339
+ * @memberof DocumentsApiConvertToBase64
340
+ */
341
+ readonly authorization?: string;
342
+ }
286
343
  /**
287
344
  * Request parameters for createDocument operation in DocumentsApi.
288
345
  * @export
@@ -496,6 +553,15 @@ export interface DocumentsApiUpdateDocumentRequest {
496
553
  * @extends {BaseAPI}
497
554
  */
498
555
  export declare class DocumentsApi extends BaseAPI {
556
+ /**
557
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
558
+ * @summary Convert document to base64
559
+ * @param {DocumentsApiConvertToBase64Request} requestParameters Request parameters.
560
+ * @param {*} [options] Override http request option.
561
+ * @throws {RequiredError}
562
+ * @memberof DocumentsApi
563
+ */
564
+ convertToBase64(requestParameters: DocumentsApiConvertToBase64Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConvertToBase64ResponseClass, any>>;
499
565
  /**
500
566
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
501
567
  * @summary Create the document
@@ -551,7 +617,7 @@ export declare class DocumentsApi extends BaseAPI {
551
617
  */
552
618
  listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
553
619
  /**
554
- * 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\"
620
+ * 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\"
555
621
  * @summary Save external document
556
622
  * @param {DocumentsApiSaveExternalDocumentRequest} requestParameters Request parameters.
557
623
  * @param {*} [options] Override http request option.