@emilgroup/document-sdk-node 1.41.1-beta.0 → 1.41.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.
@@ -16,9 +16,14 @@ import { CreateDocumentRequestDto } from '../models';
16
16
  import { CreateDocumentSyncResponseClass } from '../models';
17
17
  import { CreatePresignedPostRequestDto } from '../models';
18
18
  import { CreatePresignedPostResponseClass } from '../models';
19
+ import { CreateQrBillDocumentRequestDto } from '../models';
20
+ import { ExportDocumentRequestDto } from '../models';
21
+ import { ExportDocumentResponseClass } from '../models';
19
22
  import { GetDocumentDownloadUrlResponseClass } from '../models';
20
23
  import { GetSignedS3KeyUrlResponseClass } from '../models';
21
24
  import { ListDocumentsResponseClass } from '../models';
25
+ import { MergeDocumentsRequestDto } from '../models';
26
+ import { MergeDocumentsResponseClass } from '../models';
22
27
  import { SaveExternalDocumentRequestDto } from '../models';
23
28
  import { UpdateDocumentRequestDto } from '../models';
24
29
  import { UpdateDocumentResponseClass } from '../models';
@@ -45,6 +50,15 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
45
50
  * @throws {RequiredError}
46
51
  */
47
52
  createPresignedPost: (createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
+ /**
54
+ * Creates a Swiss QR bill PDF document **Required Permissions** \"document-management.documents.create\"
55
+ * @summary Create the QR bill document
56
+ * @param {CreateQrBillDocumentRequestDto} createQrBillDocumentRequestDto
57
+ * @param {string} [authorization] Bearer Token
58
+ * @param {*} [options] Override http request option.
59
+ * @throws {RequiredError}
60
+ */
61
+ createQrBillDocument: (createQrBillDocumentRequestDto: CreateQrBillDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48
62
  /**
49
63
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
50
64
  * @summary Delete the document
@@ -54,6 +68,16 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
54
68
  * @throws {RequiredError}
55
69
  */
56
70
  deleteDocument: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
71
+ /**
72
+ * This will fetch an internal document and export it to a third party API **Required Permissions** \"document-management.documents.create\"
73
+ * @summary Export internal document
74
+ * @param {string} code Document code
75
+ * @param {ExportDocumentRequestDto} exportDocumentRequestDto
76
+ * @param {string} [authorization] Bearer Token
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ exportDocument: (code: string, exportDocumentRequestDto: ExportDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
57
81
  /**
58
82
  * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
59
83
  * @summary Fetches a document download URL
@@ -90,7 +114,16 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
90
114
  */
91
115
  listDocuments: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
92
116
  /**
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\"
117
+ * Merges 2-5 PDF documents into a single PDF **Required Permissions** \"document-management.documents.delete\"
118
+ * @summary Create the merged document
119
+ * @param {MergeDocumentsRequestDto} mergeDocumentsRequestDto
120
+ * @param {string} [authorization] Bearer Token
121
+ * @param {*} [options] Override http request option.
122
+ * @throws {RequiredError}
123
+ */
124
+ mergeDocuments: (mergeDocumentsRequestDto: MergeDocumentsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
125
+ /**
126
+ * 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
127
  * @summary Save external document
95
128
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
96
129
  * @param {string} [authorization] Bearer Token
@@ -132,6 +165,15 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
132
165
  * @throws {RequiredError}
133
166
  */
134
167
  createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
168
+ /**
169
+ * Creates a Swiss QR bill PDF document **Required Permissions** \"document-management.documents.create\"
170
+ * @summary Create the QR bill document
171
+ * @param {CreateQrBillDocumentRequestDto} createQrBillDocumentRequestDto
172
+ * @param {string} [authorization] Bearer Token
173
+ * @param {*} [options] Override http request option.
174
+ * @throws {RequiredError}
175
+ */
176
+ createQrBillDocument(createQrBillDocumentRequestDto: CreateQrBillDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
135
177
  /**
136
178
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
137
179
  * @summary Delete the document
@@ -141,6 +183,16 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
141
183
  * @throws {RequiredError}
142
184
  */
143
185
  deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
186
+ /**
187
+ * This will fetch an internal document and export it to a third party API **Required Permissions** \"document-management.documents.create\"
188
+ * @summary Export internal document
189
+ * @param {string} code Document code
190
+ * @param {ExportDocumentRequestDto} exportDocumentRequestDto
191
+ * @param {string} [authorization] Bearer Token
192
+ * @param {*} [options] Override http request option.
193
+ * @throws {RequiredError}
194
+ */
195
+ exportDocument(code: string, exportDocumentRequestDto: ExportDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportDocumentResponseClass>>;
144
196
  /**
145
197
  * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
146
198
  * @summary Fetches a document download URL
@@ -177,7 +229,16 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
177
229
  */
178
230
  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
231
  /**
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\"
232
+ * Merges 2-5 PDF documents into a single PDF **Required Permissions** \"document-management.documents.delete\"
233
+ * @summary Create the merged document
234
+ * @param {MergeDocumentsRequestDto} mergeDocumentsRequestDto
235
+ * @param {string} [authorization] Bearer Token
236
+ * @param {*} [options] Override http request option.
237
+ * @throws {RequiredError}
238
+ */
239
+ mergeDocuments(mergeDocumentsRequestDto: MergeDocumentsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MergeDocumentsResponseClass>>;
240
+ /**
241
+ * 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
242
  * @summary Save external document
182
243
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
183
244
  * @param {string} [authorization] Bearer Token
@@ -219,6 +280,15 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
219
280
  * @throws {RequiredError}
220
281
  */
221
282
  createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
283
+ /**
284
+ * Creates a Swiss QR bill PDF document **Required Permissions** \"document-management.documents.create\"
285
+ * @summary Create the QR bill document
286
+ * @param {CreateQrBillDocumentRequestDto} createQrBillDocumentRequestDto
287
+ * @param {string} [authorization] Bearer Token
288
+ * @param {*} [options] Override http request option.
289
+ * @throws {RequiredError}
290
+ */
291
+ createQrBillDocument(createQrBillDocumentRequestDto: CreateQrBillDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
222
292
  /**
223
293
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
224
294
  * @summary Delete the document
@@ -228,6 +298,16 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
228
298
  * @throws {RequiredError}
229
299
  */
230
300
  deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<object>;
301
+ /**
302
+ * This will fetch an internal document and export it to a third party API **Required Permissions** \"document-management.documents.create\"
303
+ * @summary Export internal document
304
+ * @param {string} code Document code
305
+ * @param {ExportDocumentRequestDto} exportDocumentRequestDto
306
+ * @param {string} [authorization] Bearer Token
307
+ * @param {*} [options] Override http request option.
308
+ * @throws {RequiredError}
309
+ */
310
+ exportDocument(code: string, exportDocumentRequestDto: ExportDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<ExportDocumentResponseClass>;
231
311
  /**
232
312
  * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
233
313
  * @summary Fetches a document download URL
@@ -264,7 +344,16 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
264
344
  */
265
345
  listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
266
346
  /**
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\"
347
+ * Merges 2-5 PDF documents into a single PDF **Required Permissions** \"document-management.documents.delete\"
348
+ * @summary Create the merged document
349
+ * @param {MergeDocumentsRequestDto} mergeDocumentsRequestDto
350
+ * @param {string} [authorization] Bearer Token
351
+ * @param {*} [options] Override http request option.
352
+ * @throws {RequiredError}
353
+ */
354
+ mergeDocuments(mergeDocumentsRequestDto: MergeDocumentsRequestDto, authorization?: string, options?: any): AxiosPromise<MergeDocumentsResponseClass>;
355
+ /**
356
+ * 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
357
  * @summary Save external document
269
358
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
270
359
  * @param {string} [authorization] Bearer Token
@@ -321,6 +410,25 @@ export interface DocumentsApiCreatePresignedPostRequest {
321
410
  */
322
411
  readonly authorization?: string;
323
412
  }
413
+ /**
414
+ * Request parameters for createQrBillDocument operation in DocumentsApi.
415
+ * @export
416
+ * @interface DocumentsApiCreateQrBillDocumentRequest
417
+ */
418
+ export interface DocumentsApiCreateQrBillDocumentRequest {
419
+ /**
420
+ *
421
+ * @type {CreateQrBillDocumentRequestDto}
422
+ * @memberof DocumentsApiCreateQrBillDocument
423
+ */
424
+ readonly createQrBillDocumentRequestDto: CreateQrBillDocumentRequestDto;
425
+ /**
426
+ * Bearer Token
427
+ * @type {string}
428
+ * @memberof DocumentsApiCreateQrBillDocument
429
+ */
430
+ readonly authorization?: string;
431
+ }
324
432
  /**
325
433
  * Request parameters for deleteDocument operation in DocumentsApi.
326
434
  * @export
@@ -340,6 +448,31 @@ export interface DocumentsApiDeleteDocumentRequest {
340
448
  */
341
449
  readonly authorization?: string;
342
450
  }
451
+ /**
452
+ * Request parameters for exportDocument operation in DocumentsApi.
453
+ * @export
454
+ * @interface DocumentsApiExportDocumentRequest
455
+ */
456
+ export interface DocumentsApiExportDocumentRequest {
457
+ /**
458
+ * Document code
459
+ * @type {string}
460
+ * @memberof DocumentsApiExportDocument
461
+ */
462
+ readonly code: string;
463
+ /**
464
+ *
465
+ * @type {ExportDocumentRequestDto}
466
+ * @memberof DocumentsApiExportDocument
467
+ */
468
+ readonly exportDocumentRequestDto: ExportDocumentRequestDto;
469
+ /**
470
+ * Bearer Token
471
+ * @type {string}
472
+ * @memberof DocumentsApiExportDocument
473
+ */
474
+ readonly authorization?: string;
475
+ }
343
476
  /**
344
477
  * Request parameters for getDocumentDownloadUrl operation in DocumentsApi.
345
478
  * @export
@@ -445,6 +578,25 @@ export interface DocumentsApiListDocumentsRequest {
445
578
  */
446
579
  readonly filters?: string;
447
580
  }
581
+ /**
582
+ * Request parameters for mergeDocuments operation in DocumentsApi.
583
+ * @export
584
+ * @interface DocumentsApiMergeDocumentsRequest
585
+ */
586
+ export interface DocumentsApiMergeDocumentsRequest {
587
+ /**
588
+ *
589
+ * @type {MergeDocumentsRequestDto}
590
+ * @memberof DocumentsApiMergeDocuments
591
+ */
592
+ readonly mergeDocumentsRequestDto: MergeDocumentsRequestDto;
593
+ /**
594
+ * Bearer Token
595
+ * @type {string}
596
+ * @memberof DocumentsApiMergeDocuments
597
+ */
598
+ readonly authorization?: string;
599
+ }
448
600
  /**
449
601
  * Request parameters for saveExternalDocument operation in DocumentsApi.
450
602
  * @export
@@ -514,6 +666,15 @@ export declare class DocumentsApi extends BaseAPI {
514
666
  * @memberof DocumentsApi
515
667
  */
516
668
  createPresignedPost(requestParameters: DocumentsApiCreatePresignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any, {}>>;
669
+ /**
670
+ * Creates a Swiss QR bill PDF document **Required Permissions** \"document-management.documents.create\"
671
+ * @summary Create the QR bill document
672
+ * @param {DocumentsApiCreateQrBillDocumentRequest} requestParameters Request parameters.
673
+ * @param {*} [options] Override http request option.
674
+ * @throws {RequiredError}
675
+ * @memberof DocumentsApi
676
+ */
677
+ createQrBillDocument(requestParameters: DocumentsApiCreateQrBillDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
517
678
  /**
518
679
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
519
680
  * @summary Delete the document
@@ -523,6 +684,15 @@ export declare class DocumentsApi extends BaseAPI {
523
684
  * @memberof DocumentsApi
524
685
  */
525
686
  deleteDocument(requestParameters: DocumentsApiDeleteDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
687
+ /**
688
+ * This will fetch an internal document and export it to a third party API **Required Permissions** \"document-management.documents.create\"
689
+ * @summary Export internal document
690
+ * @param {DocumentsApiExportDocumentRequest} requestParameters Request parameters.
691
+ * @param {*} [options] Override http request option.
692
+ * @throws {RequiredError}
693
+ * @memberof DocumentsApi
694
+ */
695
+ exportDocument(requestParameters: DocumentsApiExportDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportDocumentResponseClass, any, {}>>;
526
696
  /**
527
697
  * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
528
698
  * @summary Fetches a document download URL
@@ -551,7 +721,16 @@ export declare class DocumentsApi extends BaseAPI {
551
721
  */
552
722
  listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any, {}>>;
553
723
  /**
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\"
724
+ * Merges 2-5 PDF documents into a single PDF **Required Permissions** \"document-management.documents.delete\"
725
+ * @summary Create the merged document
726
+ * @param {DocumentsApiMergeDocumentsRequest} requestParameters Request parameters.
727
+ * @param {*} [options] Override http request option.
728
+ * @throws {RequiredError}
729
+ * @memberof DocumentsApi
730
+ */
731
+ mergeDocuments(requestParameters: DocumentsApiMergeDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MergeDocumentsResponseClass, any, {}>>;
732
+ /**
733
+ * 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
734
  * @summary Save external document
556
735
  * @param {DocumentsApiSaveExternalDocumentRequest} requestParameters Request parameters.
557
736
  * @param {*} [options] Override http request option.