@emilgroup/document-sdk 1.40.1-beta.1 → 1.40.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@1.40.1-beta.1 --save
20
+ npm install @emilgroup/document-sdk@1.40.1-beta.2 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk@1.40.1-beta.1
24
+ yarn add @emilgroup/document-sdk@1.40.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';
@@ -46,6 +50,57 @@ import { UpdateDocumentResponseClass } from '../models';
46
50
  */
47
51
  export const DocumentsApiAxiosParamCreator = function (configuration?: Configuration) {
48
52
  return {
53
+ /**
54
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
55
+ * @summary Convert document to base64
56
+ * @param {string} code Document code
57
+ * @param {ConvertToBase64RequestDto} convertToBase64RequestDto
58
+ * @param {string} [authorization] Bearer Token
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ convertToBase64: async (code: string, convertToBase64RequestDto: ConvertToBase64RequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
63
+ // verify required parameter 'code' is not null or undefined
64
+ assertParamExists('convertToBase64', 'code', code)
65
+ // verify required parameter 'convertToBase64RequestDto' is not null or undefined
66
+ assertParamExists('convertToBase64', 'convertToBase64RequestDto', convertToBase64RequestDto)
67
+ const localVarPath = `/documentservice/v1/documents/{code}/base64`
68
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
69
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
70
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
71
+ let baseOptions;
72
+ let baseAccessToken;
73
+ if (configuration) {
74
+ baseOptions = configuration.baseOptions;
75
+ baseAccessToken = configuration.accessToken;
76
+ }
77
+
78
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
79
+ const localVarHeaderParameter = {} as any;
80
+ const localVarQueryParameter = {} as any;
81
+
82
+ // authentication bearer required
83
+ // http bearer authentication required
84
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
85
+
86
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
87
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
88
+ }
89
+
90
+
91
+
92
+ localVarHeaderParameter['Content-Type'] = 'application/json';
93
+
94
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
95
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
96
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
97
+ localVarRequestOptions.data = serializeDataIfNeeded(convertToBase64RequestDto, localVarRequestOptions, configuration)
98
+
99
+ return {
100
+ url: toPathString(localVarUrlObj),
101
+ options: localVarRequestOptions,
102
+ };
103
+ },
49
104
  /**
50
105
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
51
106
  * @summary Create the document
@@ -365,7 +420,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
365
420
  };
366
421
  },
367
422
  /**
368
- * 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\"
423
+ * 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\"
369
424
  * @summary Save external document
370
425
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
371
426
  * @param {string} [authorization] Bearer Token
@@ -472,6 +527,19 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
472
527
  export const DocumentsApiFp = function(configuration?: Configuration) {
473
528
  const localVarAxiosParamCreator = DocumentsApiAxiosParamCreator(configuration)
474
529
  return {
530
+ /**
531
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
532
+ * @summary Convert document to base64
533
+ * @param {string} code Document code
534
+ * @param {ConvertToBase64RequestDto} convertToBase64RequestDto
535
+ * @param {string} [authorization] Bearer Token
536
+ * @param {*} [options] Override http request option.
537
+ * @throws {RequiredError}
538
+ */
539
+ async convertToBase64(code: string, convertToBase64RequestDto: ConvertToBase64RequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConvertToBase64ResponseClass>> {
540
+ const localVarAxiosArgs = await localVarAxiosParamCreator.convertToBase64(code, convertToBase64RequestDto, authorization, options);
541
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
542
+ },
475
543
  /**
476
544
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
477
545
  * @summary Create the document
@@ -553,7 +621,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
553
621
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
554
622
  },
555
623
  /**
556
- * 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\"
624
+ * 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\"
557
625
  * @summary Save external document
558
626
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
559
627
  * @param {string} [authorization] Bearer Token
@@ -587,6 +655,18 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
587
655
  export const DocumentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
588
656
  const localVarFp = DocumentsApiFp(configuration)
589
657
  return {
658
+ /**
659
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
660
+ * @summary Convert document to base64
661
+ * @param {string} code Document code
662
+ * @param {ConvertToBase64RequestDto} convertToBase64RequestDto
663
+ * @param {string} [authorization] Bearer Token
664
+ * @param {*} [options] Override http request option.
665
+ * @throws {RequiredError}
666
+ */
667
+ convertToBase64(code: string, convertToBase64RequestDto: ConvertToBase64RequestDto, authorization?: string, options?: any): AxiosPromise<ConvertToBase64ResponseClass> {
668
+ return localVarFp.convertToBase64(code, convertToBase64RequestDto, authorization, options).then((request) => request(axios, basePath));
669
+ },
590
670
  /**
591
671
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
592
672
  * @summary Create the document
@@ -662,7 +742,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
662
742
  return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
663
743
  },
664
744
  /**
665
- * 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\"
745
+ * 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\"
666
746
  * @summary Save external document
667
747
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
668
748
  * @param {string} [authorization] Bearer Token
@@ -687,6 +767,34 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
687
767
  };
688
768
  };
689
769
 
770
+ /**
771
+ * Request parameters for convertToBase64 operation in DocumentsApi.
772
+ * @export
773
+ * @interface DocumentsApiConvertToBase64Request
774
+ */
775
+ export interface DocumentsApiConvertToBase64Request {
776
+ /**
777
+ * Document code
778
+ * @type {string}
779
+ * @memberof DocumentsApiConvertToBase64
780
+ */
781
+ readonly code: string
782
+
783
+ /**
784
+ *
785
+ * @type {ConvertToBase64RequestDto}
786
+ * @memberof DocumentsApiConvertToBase64
787
+ */
788
+ readonly convertToBase64RequestDto: ConvertToBase64RequestDto
789
+
790
+ /**
791
+ * Bearer Token
792
+ * @type {string}
793
+ * @memberof DocumentsApiConvertToBase64
794
+ */
795
+ readonly authorization?: string
796
+ }
797
+
690
798
  /**
691
799
  * Request parameters for createDocument operation in DocumentsApi.
692
800
  * @export
@@ -925,6 +1033,18 @@ export interface DocumentsApiUpdateDocumentRequest {
925
1033
  * @extends {BaseAPI}
926
1034
  */
927
1035
  export class DocumentsApi extends BaseAPI {
1036
+ /**
1037
+ * Converts a document to base64 format with optional gzip compression for Zurich integration **Required Permissions** \"document-management.documents.view\"
1038
+ * @summary Convert document to base64
1039
+ * @param {DocumentsApiConvertToBase64Request} requestParameters Request parameters.
1040
+ * @param {*} [options] Override http request option.
1041
+ * @throws {RequiredError}
1042
+ * @memberof DocumentsApi
1043
+ */
1044
+ public convertToBase64(requestParameters: DocumentsApiConvertToBase64Request, options?: AxiosRequestConfig) {
1045
+ return DocumentsApiFp(this.configuration).convertToBase64(requestParameters.code, requestParameters.convertToBase64RequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1046
+ }
1047
+
928
1048
  /**
929
1049
  * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
930
1050
  * @summary Create the document
@@ -998,7 +1118,7 @@ export class DocumentsApi extends BaseAPI {
998
1118
  }
999
1119
 
1000
1120
  /**
1001
- * 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\"
1121
+ * 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\"
1002
1122
  * @summary Save external document
1003
1123
  * @param {DocumentsApiSaveExternalDocumentRequest} requestParameters Request parameters.
1004
1124
  * @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
  };
@@ -107,14 +98,10 @@ var DefaultApiAxiosParamCreator = function (configuration) {
107
98
  * @param {*} [options] Override http request option.
108
99
  * @throws {RequiredError}
109
100
  */
110
- check: function () {
111
- var args_1 = [];
112
- for (var _i = 0; _i < arguments.length; _i++) {
113
- args_1[_i] = arguments[_i];
114
- }
115
- return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
101
+ check: function (options) {
102
+ if (options === void 0) { options = {}; }
103
+ return __awaiter(_this, void 0, void 0, function () {
116
104
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
117
- if (options === void 0) { options = {}; }
118
105
  return __generator(this, function (_a) {
119
106
  localVarPath = "/documentservice/health";
120
107
  localVarUrlObj = new 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
  };
@@ -109,14 +100,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
109
100
  * @param {*} [options] Override http request option.
110
101
  * @throws {RequiredError}
111
102
  */
112
- createDocTemplate: function (createDocTemplateRequestDto_1, authorization_1) {
113
- var args_1 = [];
114
- for (var _i = 2; _i < arguments.length; _i++) {
115
- args_1[_i - 2] = arguments[_i];
116
- }
117
- return __awaiter(_this, __spreadArray([createDocTemplateRequestDto_1, authorization_1], args_1, true), void 0, function (createDocTemplateRequestDto, authorization, options) {
103
+ createDocTemplate: function (createDocTemplateRequestDto, authorization, options) {
104
+ if (options === void 0) { options = {}; }
105
+ return __awaiter(_this, void 0, void 0, function () {
118
106
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
119
- if (options === void 0) { options = {}; }
120
107
  return __generator(this, function (_a) {
121
108
  switch (_a.label) {
122
109
  case 0:
@@ -162,14 +149,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
162
149
  * @param {*} [options] Override http request option.
163
150
  * @throws {RequiredError}
164
151
  */
165
- deleteDocTemplate: function (id_1, authorization_1) {
166
- var args_1 = [];
167
- for (var _i = 2; _i < arguments.length; _i++) {
168
- args_1[_i - 2] = arguments[_i];
169
- }
170
- return __awaiter(_this, __spreadArray([id_1, authorization_1], args_1, true), void 0, function (id, authorization, options) {
152
+ deleteDocTemplate: function (id, authorization, options) {
153
+ if (options === void 0) { options = {}; }
154
+ return __awaiter(_this, void 0, void 0, function () {
171
155
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
172
- if (options === void 0) { options = {}; }
173
156
  return __generator(this, function (_a) {
174
157
  switch (_a.label) {
175
158
  case 0:
@@ -215,14 +198,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
215
198
  * @param {*} [options] Override http request option.
216
199
  * @throws {RequiredError}
217
200
  */
218
- getDocTemplate: function (id_1, authorization_1, expand_1) {
219
- var args_1 = [];
220
- for (var _i = 3; _i < arguments.length; _i++) {
221
- args_1[_i - 3] = arguments[_i];
222
- }
223
- return __awaiter(_this, __spreadArray([id_1, authorization_1, expand_1], args_1, true), void 0, function (id, authorization, expand, options) {
201
+ getDocTemplate: function (id, authorization, expand, options) {
202
+ if (options === void 0) { options = {}; }
203
+ return __awaiter(_this, void 0, void 0, function () {
224
204
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
225
- if (options === void 0) { options = {}; }
226
205
  return __generator(this, function (_a) {
227
206
  switch (_a.label) {
228
207
  case 0:
@@ -275,14 +254,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
275
254
  * @param {*} [options] Override http request option.
276
255
  * @throws {RequiredError}
277
256
  */
278
- listDocTemplates: function (authorization_1, pageSize_1, pageToken_1, filter_1, search_1, order_1, expand_1) {
279
- var args_1 = [];
280
- for (var _i = 7; _i < arguments.length; _i++) {
281
- args_1[_i - 7] = arguments[_i];
282
- }
283
- 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) {
257
+ listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
258
+ if (options === void 0) { options = {}; }
259
+ return __awaiter(_this, void 0, void 0, function () {
284
260
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
285
- if (options === void 0) { options = {}; }
286
261
  return __generator(this, function (_a) {
287
262
  switch (_a.label) {
288
263
  case 0:
@@ -343,14 +318,10 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
343
318
  * @param {*} [options] Override http request option.
344
319
  * @throws {RequiredError}
345
320
  */
346
- updateDocTemplate: function (id_1, updateDocTemplateRequestDto_1, authorization_1) {
347
- var args_1 = [];
348
- for (var _i = 3; _i < arguments.length; _i++) {
349
- args_1[_i - 3] = arguments[_i];
350
- }
351
- return __awaiter(_this, __spreadArray([id_1, updateDocTemplateRequestDto_1, authorization_1], args_1, true), void 0, function (id, updateDocTemplateRequestDto, authorization, options) {
321
+ updateDocTemplate: function (id, updateDocTemplateRequestDto, authorization, options) {
322
+ if (options === void 0) { options = {}; }
323
+ return __awaiter(_this, void 0, void 0, function () {
352
324
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
353
- if (options === void 0) { options = {}; }
354
325
  return __generator(this, function (_a) {
355
326
  switch (_a.label) {
356
327
  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.