@emilgroup/document-sdk-node 1.37.0 → 1.37.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -28,7 +28,7 @@ import { UpdateDocumentResponseClass } from '../models';
28
28
  */
29
29
  export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
30
30
  /**
31
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
31
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
32
32
  * @summary Create the document
33
33
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
34
34
  * @param {string} [authorization] Bearer Token
@@ -37,7 +37,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
37
37
  */
38
38
  createDocument: (createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
39
  /**
40
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
40
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
41
41
  * @summary Upload documents using pre-signed URL
42
42
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
43
43
  * @param {string} [authorization] Bearer Token
@@ -46,7 +46,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
46
46
  */
47
47
  createPresignedPost: (createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48
48
  /**
49
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
49
+ * 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
50
  * @summary Delete the document
51
51
  * @param {string} code
52
52
  * @param {string} [authorization] Bearer Token
@@ -55,7 +55,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
55
55
  */
56
56
  deleteDocument: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
57
57
  /**
58
- * This will return a presigned URL to download the document.
58
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
59
59
  * @summary Fetches a document download URL
60
60
  * @param {string} code Document code
61
61
  * @param {string} [authorization] Bearer Token
@@ -65,7 +65,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
65
65
  */
66
66
  getDocumentDownloadUrl: (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
67
67
  /**
68
- * This will return a presigned URL for a random S3 key
68
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
69
69
  * @summary Fetches a presigned URL for a S3 key
70
70
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
71
71
  * @param {string} [authorization] Bearer Token
@@ -75,7 +75,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
75
75
  */
76
76
  getSignedS3keyUrl: (s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
77
  /**
78
- * 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.
78
+ * 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
79
  * @summary List documents
80
80
  * @param {string} [authorization] Bearer Token
81
81
  * @param {number} [pageSize] Page size
@@ -90,7 +90,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
90
90
  */
91
91
  listDocuments: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
92
92
  /**
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.
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\"
94
94
  * @summary Save external document
95
95
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
96
96
  * @param {string} [authorization] Bearer Token
@@ -99,7 +99,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
99
99
  */
100
100
  saveExternalDocument: (saveExternalDocumentRequestDto: SaveExternalDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
101
101
  /**
102
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
102
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
103
103
  * @summary Update the document
104
104
  * @param {string} code
105
105
  * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
@@ -115,7 +115,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
115
115
  */
116
116
  export declare const DocumentsApiFp: (configuration?: Configuration) => {
117
117
  /**
118
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
118
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
119
119
  * @summary Create the document
120
120
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
121
121
  * @param {string} [authorization] Bearer Token
@@ -124,7 +124,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
124
124
  */
125
125
  createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocumentSyncResponseClass>>;
126
126
  /**
127
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
127
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
128
128
  * @summary Upload documents using pre-signed URL
129
129
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
130
130
  * @param {string} [authorization] Bearer Token
@@ -133,7 +133,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
133
133
  */
134
134
  createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
135
135
  /**
136
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
136
+ * 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
137
  * @summary Delete the document
138
138
  * @param {string} code
139
139
  * @param {string} [authorization] Bearer Token
@@ -142,7 +142,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
142
142
  */
143
143
  deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
144
144
  /**
145
- * This will return a presigned URL to download the document.
145
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
146
146
  * @summary Fetches a document download URL
147
147
  * @param {string} code Document code
148
148
  * @param {string} [authorization] Bearer Token
@@ -152,7 +152,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
152
152
  */
153
153
  getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>>;
154
154
  /**
155
- * This will return a presigned URL for a random S3 key
155
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
156
156
  * @summary Fetches a presigned URL for a S3 key
157
157
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
158
158
  * @param {string} [authorization] Bearer Token
@@ -162,7 +162,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
162
162
  */
163
163
  getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignedS3KeyUrlResponseClass>>;
164
164
  /**
165
- * 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.
165
+ * 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
166
  * @summary List documents
167
167
  * @param {string} [authorization] Bearer Token
168
168
  * @param {number} [pageSize] Page size
@@ -177,7 +177,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
177
177
  */
178
178
  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
179
  /**
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.
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\"
181
181
  * @summary Save external document
182
182
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
183
183
  * @param {string} [authorization] Bearer Token
@@ -186,7 +186,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
186
186
  */
187
187
  saveExternalDocument(saveExternalDocumentRequestDto: SaveExternalDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
188
188
  /**
189
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
189
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
190
190
  * @summary Update the document
191
191
  * @param {string} code
192
192
  * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
@@ -202,7 +202,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
202
202
  */
203
203
  export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
204
204
  /**
205
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
205
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
206
206
  * @summary Create the document
207
207
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
208
208
  * @param {string} [authorization] Bearer Token
@@ -211,7 +211,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
211
211
  */
212
212
  createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocumentSyncResponseClass>;
213
213
  /**
214
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
214
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
215
215
  * @summary Upload documents using pre-signed URL
216
216
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
217
217
  * @param {string} [authorization] Bearer Token
@@ -220,7 +220,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
220
220
  */
221
221
  createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
222
222
  /**
223
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
223
+ * 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
224
  * @summary Delete the document
225
225
  * @param {string} code
226
226
  * @param {string} [authorization] Bearer Token
@@ -229,7 +229,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
229
229
  */
230
230
  deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<object>;
231
231
  /**
232
- * This will return a presigned URL to download the document.
232
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
233
233
  * @summary Fetches a document download URL
234
234
  * @param {string} code Document code
235
235
  * @param {string} [authorization] Bearer Token
@@ -239,7 +239,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
239
239
  */
240
240
  getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass>;
241
241
  /**
242
- * This will return a presigned URL for a random S3 key
242
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
243
243
  * @summary Fetches a presigned URL for a S3 key
244
244
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
245
245
  * @param {string} [authorization] Bearer Token
@@ -249,7 +249,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
249
249
  */
250
250
  getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass>;
251
251
  /**
252
- * 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.
252
+ * 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
253
  * @summary List documents
254
254
  * @param {string} [authorization] Bearer Token
255
255
  * @param {number} [pageSize] Page size
@@ -264,7 +264,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
264
264
  */
265
265
  listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
266
266
  /**
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.
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\"
268
268
  * @summary Save external document
269
269
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
270
270
  * @param {string} [authorization] Bearer Token
@@ -273,7 +273,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
273
273
  */
274
274
  saveExternalDocument(saveExternalDocumentRequestDto: SaveExternalDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
275
275
  /**
276
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
276
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
277
277
  * @summary Update the document
278
278
  * @param {string} code
279
279
  * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
@@ -497,7 +497,7 @@ export interface DocumentsApiUpdateDocumentRequest {
497
497
  */
498
498
  export declare class DocumentsApi extends BaseAPI {
499
499
  /**
500
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
500
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
501
501
  * @summary Create the document
502
502
  * @param {DocumentsApiCreateDocumentRequest} requestParameters Request parameters.
503
503
  * @param {*} [options] Override http request option.
@@ -506,7 +506,7 @@ export declare class DocumentsApi extends BaseAPI {
506
506
  */
507
507
  createDocument(requestParameters: DocumentsApiCreateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDocumentSyncResponseClass, any>>;
508
508
  /**
509
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
509
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
510
510
  * @summary Upload documents using pre-signed URL
511
511
  * @param {DocumentsApiCreatePresignedPostRequest} requestParameters Request parameters.
512
512
  * @param {*} [options] Override http request option.
@@ -515,7 +515,7 @@ export declare class DocumentsApi extends BaseAPI {
515
515
  */
516
516
  createPresignedPost(requestParameters: DocumentsApiCreatePresignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
517
517
  /**
518
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
518
+ * 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
519
  * @summary Delete the document
520
520
  * @param {DocumentsApiDeleteDocumentRequest} requestParameters Request parameters.
521
521
  * @param {*} [options] Override http request option.
@@ -524,7 +524,7 @@ export declare class DocumentsApi extends BaseAPI {
524
524
  */
525
525
  deleteDocument(requestParameters: DocumentsApiDeleteDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
526
526
  /**
527
- * This will return a presigned URL to download the document.
527
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
528
528
  * @summary Fetches a document download URL
529
529
  * @param {DocumentsApiGetDocumentDownloadUrlRequest} requestParameters Request parameters.
530
530
  * @param {*} [options] Override http request option.
@@ -533,7 +533,7 @@ export declare class DocumentsApi extends BaseAPI {
533
533
  */
534
534
  getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocumentDownloadUrlResponseClass, any>>;
535
535
  /**
536
- * This will return a presigned URL for a random S3 key
536
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
537
537
  * @summary Fetches a presigned URL for a S3 key
538
538
  * @param {DocumentsApiGetSignedS3keyUrlRequest} requestParameters Request parameters.
539
539
  * @param {*} [options] Override http request option.
@@ -542,7 +542,7 @@ export declare class DocumentsApi extends BaseAPI {
542
542
  */
543
543
  getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignedS3KeyUrlResponseClass, any>>;
544
544
  /**
545
- * 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.
545
+ * 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\"
546
546
  * @summary List documents
547
547
  * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
548
548
  * @param {*} [options] Override http request option.
@@ -551,7 +551,7 @@ export declare class DocumentsApi extends BaseAPI {
551
551
  */
552
552
  listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
553
553
  /**
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.
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\"
555
555
  * @summary Save external document
556
556
  * @param {DocumentsApiSaveExternalDocumentRequest} requestParameters Request parameters.
557
557
  * @param {*} [options] Override http request option.
@@ -560,7 +560,7 @@ export declare class DocumentsApi extends BaseAPI {
560
560
  */
561
561
  saveExternalDocument(requestParameters: DocumentsApiSaveExternalDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
562
562
  /**
563
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
563
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
564
564
  * @summary Update the document
565
565
  * @param {DocumentsApiUpdateDocumentRequest} requestParameters Request parameters.
566
566
  * @param {*} [options] Override http request option.
@@ -97,7 +97,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
100
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
101
101
  * @summary Create the document
102
102
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
103
103
  * @param {string} [authorization] Bearer Token
@@ -146,7 +146,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
146
146
  });
147
147
  },
148
148
  /**
149
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
149
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
150
150
  * @summary Upload documents using pre-signed URL
151
151
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
152
152
  * @param {string} [authorization] Bearer Token
@@ -195,7 +195,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
195
195
  });
196
196
  },
197
197
  /**
198
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
198
+ * 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\"
199
199
  * @summary Delete the document
200
200
  * @param {string} code
201
201
  * @param {string} [authorization] Bearer Token
@@ -243,7 +243,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
243
243
  });
244
244
  },
245
245
  /**
246
- * This will return a presigned URL to download the document.
246
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
247
247
  * @summary Fetches a document download URL
248
248
  * @param {string} code Document code
249
249
  * @param {string} [authorization] Bearer Token
@@ -295,7 +295,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
295
295
  });
296
296
  },
297
297
  /**
298
- * This will return a presigned URL for a random S3 key
298
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
299
299
  * @summary Fetches a presigned URL for a S3 key
300
300
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
301
301
  * @param {string} [authorization] Bearer Token
@@ -349,7 +349,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
349
349
  });
350
350
  },
351
351
  /**
352
- * 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.
352
+ * 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\"
353
353
  * @summary List documents
354
354
  * @param {string} [authorization] Bearer Token
355
355
  * @param {number} [pageSize] Page size
@@ -421,7 +421,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
421
421
  });
422
422
  },
423
423
  /**
424
- * 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.
424
+ * 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\"
425
425
  * @summary Save external document
426
426
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
427
427
  * @param {string} [authorization] Bearer Token
@@ -470,7 +470,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
470
470
  });
471
471
  },
472
472
  /**
473
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
473
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
474
474
  * @summary Update the document
475
475
  * @param {string} code
476
476
  * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
@@ -533,7 +533,7 @@ var DocumentsApiFp = function (configuration) {
533
533
  var localVarAxiosParamCreator = (0, exports.DocumentsApiAxiosParamCreator)(configuration);
534
534
  return {
535
535
  /**
536
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
536
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
537
537
  * @summary Create the document
538
538
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
539
539
  * @param {string} [authorization] Bearer Token
@@ -554,7 +554,7 @@ var DocumentsApiFp = function (configuration) {
554
554
  });
555
555
  },
556
556
  /**
557
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
557
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
558
558
  * @summary Upload documents using pre-signed URL
559
559
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
560
560
  * @param {string} [authorization] Bearer Token
@@ -575,7 +575,7 @@ var DocumentsApiFp = function (configuration) {
575
575
  });
576
576
  },
577
577
  /**
578
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
578
+ * 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\"
579
579
  * @summary Delete the document
580
580
  * @param {string} code
581
581
  * @param {string} [authorization] Bearer Token
@@ -596,7 +596,7 @@ var DocumentsApiFp = function (configuration) {
596
596
  });
597
597
  },
598
598
  /**
599
- * This will return a presigned URL to download the document.
599
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
600
600
  * @summary Fetches a document download URL
601
601
  * @param {string} code Document code
602
602
  * @param {string} [authorization] Bearer Token
@@ -618,7 +618,7 @@ var DocumentsApiFp = function (configuration) {
618
618
  });
619
619
  },
620
620
  /**
621
- * This will return a presigned URL for a random S3 key
621
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
622
622
  * @summary Fetches a presigned URL for a S3 key
623
623
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
624
624
  * @param {string} [authorization] Bearer Token
@@ -640,7 +640,7 @@ var DocumentsApiFp = function (configuration) {
640
640
  });
641
641
  },
642
642
  /**
643
- * 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.
643
+ * 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\"
644
644
  * @summary List documents
645
645
  * @param {string} [authorization] Bearer Token
646
646
  * @param {number} [pageSize] Page size
@@ -667,7 +667,7 @@ var DocumentsApiFp = function (configuration) {
667
667
  });
668
668
  },
669
669
  /**
670
- * 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.
670
+ * 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\"
671
671
  * @summary Save external document
672
672
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
673
673
  * @param {string} [authorization] Bearer Token
@@ -688,7 +688,7 @@ var DocumentsApiFp = function (configuration) {
688
688
  });
689
689
  },
690
690
  /**
691
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
691
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
692
692
  * @summary Update the document
693
693
  * @param {string} code
694
694
  * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
@@ -720,7 +720,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
720
720
  var localVarFp = (0, exports.DocumentsApiFp)(configuration);
721
721
  return {
722
722
  /**
723
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
723
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
724
724
  * @summary Create the document
725
725
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
726
726
  * @param {string} [authorization] Bearer Token
@@ -731,7 +731,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
731
731
  return localVarFp.createDocument(createDocumentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
732
732
  },
733
733
  /**
734
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
734
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
735
735
  * @summary Upload documents using pre-signed URL
736
736
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
737
737
  * @param {string} [authorization] Bearer Token
@@ -742,7 +742,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
742
742
  return localVarFp.createPresignedPost(createPresignedPostRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
743
743
  },
744
744
  /**
745
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
745
+ * 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\"
746
746
  * @summary Delete the document
747
747
  * @param {string} code
748
748
  * @param {string} [authorization] Bearer Token
@@ -753,7 +753,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
753
753
  return localVarFp.deleteDocument(code, authorization, options).then(function (request) { return request(axios, basePath); });
754
754
  },
755
755
  /**
756
- * This will return a presigned URL to download the document.
756
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
757
757
  * @summary Fetches a document download URL
758
758
  * @param {string} code Document code
759
759
  * @param {string} [authorization] Bearer Token
@@ -765,7 +765,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
765
765
  return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
766
766
  },
767
767
  /**
768
- * This will return a presigned URL for a random S3 key
768
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
769
769
  * @summary Fetches a presigned URL for a S3 key
770
770
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
771
771
  * @param {string} [authorization] Bearer Token
@@ -777,7 +777,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
777
777
  return localVarFp.getSignedS3keyUrl(s3Key, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
778
778
  },
779
779
  /**
780
- * 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.
780
+ * 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\"
781
781
  * @summary List documents
782
782
  * @param {string} [authorization] Bearer Token
783
783
  * @param {number} [pageSize] Page size
@@ -794,7 +794,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
794
794
  return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
795
795
  },
796
796
  /**
797
- * 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.
797
+ * 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\"
798
798
  * @summary Save external document
799
799
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
800
800
  * @param {string} [authorization] Bearer Token
@@ -805,7 +805,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
805
805
  return localVarFp.saveExternalDocument(saveExternalDocumentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
806
806
  },
807
807
  /**
808
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
808
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
809
809
  * @summary Update the document
810
810
  * @param {string} code
811
811
  * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
@@ -831,7 +831,7 @@ var DocumentsApi = /** @class */ (function (_super) {
831
831
  return _super !== null && _super.apply(this, arguments) || this;
832
832
  }
833
833
  /**
834
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
834
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
835
835
  * @summary Create the document
836
836
  * @param {DocumentsApiCreateDocumentRequest} requestParameters Request parameters.
837
837
  * @param {*} [options] Override http request option.
@@ -843,7 +843,7 @@ var DocumentsApi = /** @class */ (function (_super) {
843
843
  return (0, exports.DocumentsApiFp)(this.configuration).createDocument(requestParameters.createDocumentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
844
844
  };
845
845
  /**
846
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
846
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
847
847
  * @summary Upload documents using pre-signed URL
848
848
  * @param {DocumentsApiCreatePresignedPostRequest} requestParameters Request parameters.
849
849
  * @param {*} [options] Override http request option.
@@ -855,7 +855,7 @@ var DocumentsApi = /** @class */ (function (_super) {
855
855
  return (0, exports.DocumentsApiFp)(this.configuration).createPresignedPost(requestParameters.createPresignedPostRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
856
856
  };
857
857
  /**
858
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
858
+ * 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\"
859
859
  * @summary Delete the document
860
860
  * @param {DocumentsApiDeleteDocumentRequest} requestParameters Request parameters.
861
861
  * @param {*} [options] Override http request option.
@@ -867,7 +867,7 @@ var DocumentsApi = /** @class */ (function (_super) {
867
867
  return (0, exports.DocumentsApiFp)(this.configuration).deleteDocument(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
868
868
  };
869
869
  /**
870
- * This will return a presigned URL to download the document.
870
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
871
871
  * @summary Fetches a document download URL
872
872
  * @param {DocumentsApiGetDocumentDownloadUrlRequest} requestParameters Request parameters.
873
873
  * @param {*} [options] Override http request option.
@@ -879,7 +879,7 @@ var DocumentsApi = /** @class */ (function (_super) {
879
879
  return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
880
880
  };
881
881
  /**
882
- * This will return a presigned URL for a random S3 key
882
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
883
883
  * @summary Fetches a presigned URL for a S3 key
884
884
  * @param {DocumentsApiGetSignedS3keyUrlRequest} requestParameters Request parameters.
885
885
  * @param {*} [options] Override http request option.
@@ -891,7 +891,7 @@ var DocumentsApi = /** @class */ (function (_super) {
891
891
  return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
892
892
  };
893
893
  /**
894
- * 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.
894
+ * 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\"
895
895
  * @summary List documents
896
896
  * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
897
897
  * @param {*} [options] Override http request option.
@@ -904,7 +904,7 @@ var DocumentsApi = /** @class */ (function (_super) {
904
904
  return (0, exports.DocumentsApiFp)(this.configuration).listDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
905
905
  };
906
906
  /**
907
- * 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.
907
+ * 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\"
908
908
  * @summary Save external document
909
909
  * @param {DocumentsApiSaveExternalDocumentRequest} requestParameters Request parameters.
910
910
  * @param {*} [options] Override http request option.
@@ -916,7 +916,7 @@ var DocumentsApi = /** @class */ (function (_super) {
916
916
  return (0, exports.DocumentsApiFp)(this.configuration).saveExternalDocument(requestParameters.saveExternalDocumentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
917
917
  };
918
918
  /**
919
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
919
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
920
920
  * @summary Update the document
921
921
  * @param {DocumentsApiUpdateDocumentRequest} requestParameters Request parameters.
922
922
  * @param {*} [options] Override http request option.