@emilgroup/document-sdk-node 1.22.1-beta.2 → 1.23.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.
@@ -29,10 +29,12 @@ models/get-layout-request-dto.ts
29
29
  models/index.ts
30
30
  models/inline-response200.ts
31
31
  models/inline-response503.ts
32
+ models/list-product-documents-response-class.ts
32
33
  models/list-request-dto.ts
33
34
  models/list-search-keywords-request-dto.ts
34
35
  models/list-searchable-document-owners-request-dto.ts
35
36
  models/list-searchable-documents-request-dto.ts
37
+ models/product-document-class.ts
36
38
  models/shared-update-docx-template-request-dto.ts
37
39
  models/update-doc-template-request-dto.ts
38
40
  models/update-document-request-dto.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/document-sdk-node@1.22.1-beta.2 --save
20
+ npm install @emilgroup/document-sdk-node@1.23.1-beta.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk-node@1.22.1-beta.2
24
+ yarn add @emilgroup/document-sdk-node@1.23.1-beta.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -47,6 +47,22 @@ export EMIL_USERNAME=XXXXX@XXXX.XXX
47
47
  export EMIL_PASSWORD=XXXXXXXXXXXXXX
48
48
  ```
49
49
 
50
+ ## Base path
51
+
52
+ To select the basic path for using the API, we can use two approaches. The first is to use one of the predefined environments, and the second is to specify the domain as a string.
53
+
54
+ ```ts
55
+ import { DocumentsApi, Environment } from '@emilgroup/document-sdk-node'
56
+
57
+ const documentsApi = new DocumentsApi();
58
+
59
+ // Allows you to simply choose environment. It will usually be Environment.Production.
60
+ documentsApi.selectEnvironment(Environment.Production);
61
+
62
+ // For advanced users, use the custom baseUrl of the website you need to connect to.
63
+ documentsApi.selectBasePath('https://my-custom-domain.com');
64
+ ```
65
+
50
66
  ## Example
51
67
 
52
68
  Here is a basic functionning example:
@@ -231,13 +231,16 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
231
231
  * This will return a presigned URL for a random S3 key
232
232
  * @summary Fetches a presigned URL for a S3 key
233
233
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
234
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
234
235
  * @param {string} [authorization] Bearer Token
235
236
  * @param {*} [options] Override http request option.
236
237
  * @throws {RequiredError}
237
238
  */
238
- getSignedS3keyUrl: async (s3Key: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
239
+ getSignedS3keyUrl: async (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
239
240
  // verify required parameter 's3Key' is not null or undefined
240
241
  assertParamExists('getSignedS3keyUrl', 's3Key', s3Key)
242
+ // verify required parameter 'contentDisposition' is not null or undefined
243
+ assertParamExists('getSignedS3keyUrl', 'contentDisposition', contentDisposition)
241
244
  const localVarPath = `/documentservice/v1/documents/signed-s3-url`;
242
245
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
243
246
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -260,6 +263,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
260
263
  localVarQueryParameter['s3Key'] = s3Key;
261
264
  }
262
265
 
266
+ if (contentDisposition !== undefined) {
267
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
268
+ }
269
+
263
270
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
264
271
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
265
272
  }
@@ -465,12 +472,13 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
465
472
  * This will return a presigned URL for a random S3 key
466
473
  * @summary Fetches a presigned URL for a S3 key
467
474
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
475
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
468
476
  * @param {string} [authorization] Bearer Token
469
477
  * @param {*} [options] Override http request option.
470
478
  * @throws {RequiredError}
471
479
  */
472
- async getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
473
- const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options);
480
+ async getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
481
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options);
474
482
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
475
483
  },
476
484
  /**
@@ -563,12 +571,13 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
563
571
  * This will return a presigned URL for a random S3 key
564
572
  * @summary Fetches a presigned URL for a S3 key
565
573
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
574
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
566
575
  * @param {string} [authorization] Bearer Token
567
576
  * @param {*} [options] Override http request option.
568
577
  * @throws {RequiredError}
569
578
  */
570
- getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void> {
571
- return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then((request) => request(axios, basePath));
579
+ getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
580
+ return localVarFp.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options).then((request) => request(axios, basePath));
572
581
  },
573
582
  /**
574
583
  * 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.
@@ -706,6 +715,13 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
706
715
  */
707
716
  readonly s3Key: string
708
717
 
718
+ /**
719
+ * Content disposition override. Default will be depending on the document type.
720
+ * @type {'attachment' | 'inline'}
721
+ * @memberof DocumentsApiGetSignedS3keyUrl
722
+ */
723
+ readonly contentDisposition: 'attachment' | 'inline'
724
+
709
725
  /**
710
726
  * Bearer Token
711
727
  * @type {string}
@@ -869,7 +885,7 @@ export class DocumentsApi extends BaseAPI {
869
885
  * @memberof DocumentsApi
870
886
  */
871
887
  public getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig) {
872
- return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
888
+ return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
873
889
  }
874
890
 
875
891
  /**
@@ -21,6 +21,8 @@ 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 { ListProductDocumentsResponseClass } from '../models';
25
+ // @ts-ignore
24
26
  import { UploadProductDocumentRequestDto } from '../models';
25
27
  // URLSearchParams not necessarily used
26
28
  // @ts-ignore
@@ -187,17 +189,17 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
187
189
  };
188
190
  },
189
191
  /**
190
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
192
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
191
193
  * @summary List product documents
192
194
  * @param {string} productSlug
193
195
  * @param {string} [authorization] Bearer Token
194
196
  * @param {number} [pageSize] Page size
195
197
  * @param {string} [pageToken] Page token
196
- * @param {string} [filter] List filter
198
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
197
199
  * @param {string} [search] Search query
198
- * @param {string} [order] Ordering criteria
200
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
199
201
  * @param {string} [expand] Extra fields to fetch
200
- * @param {string} [filters] List filters
202
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
201
203
  * @param {*} [options] Override http request option.
202
204
  * @throws {RequiredError}
203
205
  */
@@ -368,21 +370,21 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
368
370
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
369
371
  },
370
372
  /**
371
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
373
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
372
374
  * @summary List product documents
373
375
  * @param {string} productSlug
374
376
  * @param {string} [authorization] Bearer Token
375
377
  * @param {number} [pageSize] Page size
376
378
  * @param {string} [pageToken] Page token
377
- * @param {string} [filter] List filter
379
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
378
380
  * @param {string} [search] Search query
379
- * @param {string} [order] Ordering criteria
381
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
380
382
  * @param {string} [expand] Extra fields to fetch
381
- * @param {string} [filters] List filters
383
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
382
384
  * @param {*} [options] Override http request option.
383
385
  * @throws {RequiredError}
384
386
  */
385
- async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
387
+ async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
386
388
  const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
387
389
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
388
390
  },
@@ -447,21 +449,21 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
447
449
  return localVarFp.getProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
448
450
  },
449
451
  /**
450
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
452
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
451
453
  * @summary List product documents
452
454
  * @param {string} productSlug
453
455
  * @param {string} [authorization] Bearer Token
454
456
  * @param {number} [pageSize] Page size
455
457
  * @param {string} [pageToken] Page token
456
- * @param {string} [filter] List filter
458
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
457
459
  * @param {string} [search] Search query
458
- * @param {string} [order] Ordering criteria
460
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
459
461
  * @param {string} [expand] Extra fields to fetch
460
- * @param {string} [filters] List filters
462
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
461
463
  * @param {*} [options] Override http request option.
462
464
  * @throws {RequiredError}
463
465
  */
464
- listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
466
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
465
467
  return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
466
468
  },
467
469
  /**
@@ -605,7 +607,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
605
607
  readonly pageToken?: string
606
608
 
607
609
  /**
608
- * List filter
610
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
609
611
  * @type {string}
610
612
  * @memberof ProductDocumentsApiListProductDocuments
611
613
  */
@@ -619,7 +621,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
619
621
  readonly search?: string
620
622
 
621
623
  /**
622
- * Ordering criteria
624
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
623
625
  * @type {string}
624
626
  * @memberof ProductDocumentsApiListProductDocuments
625
627
  */
@@ -633,7 +635,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
633
635
  readonly expand?: string
634
636
 
635
637
  /**
636
- * List filters
638
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
637
639
  * @type {string}
638
640
  * @memberof ProductDocumentsApiListProductDocuments
639
641
  */
@@ -712,7 +714,7 @@ export class ProductDocumentsApi extends BaseAPI {
712
714
  }
713
715
 
714
716
  /**
715
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
717
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
716
718
  * @summary List product documents
717
719
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
718
720
  * @param {*} [options] Override http request option.
@@ -61,11 +61,12 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
61
61
  * This will return a presigned URL for a random S3 key
62
62
  * @summary Fetches a presigned URL for a S3 key
63
63
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
64
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
64
65
  * @param {string} [authorization] Bearer Token
65
66
  * @param {*} [options] Override http request option.
66
67
  * @throws {RequiredError}
67
68
  */
68
- getSignedS3keyUrl: (s3Key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ getSignedS3keyUrl: (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
70
  /**
70
71
  * 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.
71
72
  * @summary List documents
@@ -138,11 +139,12 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
138
139
  * This will return a presigned URL for a random S3 key
139
140
  * @summary Fetches a presigned URL for a S3 key
140
141
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
142
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
141
143
  * @param {string} [authorization] Bearer Token
142
144
  * @param {*} [options] Override http request option.
143
145
  * @throws {RequiredError}
144
146
  */
145
- getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
147
+ getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
146
148
  /**
147
149
  * 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.
148
150
  * @summary List documents
@@ -215,11 +217,12 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
215
217
  * This will return a presigned URL for a random S3 key
216
218
  * @summary Fetches a presigned URL for a S3 key
217
219
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
220
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
218
221
  * @param {string} [authorization] Bearer Token
219
222
  * @param {*} [options] Override http request option.
220
223
  * @throws {RequiredError}
221
224
  */
222
- getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void>;
225
+ getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
223
226
  /**
224
227
  * 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.
225
228
  * @summary List documents
@@ -340,6 +343,12 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
340
343
  * @memberof DocumentsApiGetSignedS3keyUrl
341
344
  */
342
345
  readonly s3Key: string;
346
+ /**
347
+ * Content disposition override. Default will be depending on the document type.
348
+ * @type {'attachment' | 'inline'}
349
+ * @memberof DocumentsApiGetSignedS3keyUrl
350
+ */
351
+ readonly contentDisposition: 'attachment' | 'inline';
343
352
  /**
344
353
  * Bearer Token
345
354
  * @type {string}
@@ -300,11 +300,12 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
300
300
  * This will return a presigned URL for a random S3 key
301
301
  * @summary Fetches a presigned URL for a S3 key
302
302
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
303
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
303
304
  * @param {string} [authorization] Bearer Token
304
305
  * @param {*} [options] Override http request option.
305
306
  * @throws {RequiredError}
306
307
  */
307
- getSignedS3keyUrl: function (s3Key, authorization, options) {
308
+ getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
308
309
  if (options === void 0) { options = {}; }
309
310
  return __awaiter(_this, void 0, void 0, function () {
310
311
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -313,6 +314,8 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
313
314
  case 0:
314
315
  // verify required parameter 's3Key' is not null or undefined
315
316
  (0, common_1.assertParamExists)('getSignedS3keyUrl', 's3Key', s3Key);
317
+ // verify required parameter 'contentDisposition' is not null or undefined
318
+ (0, common_1.assertParamExists)('getSignedS3keyUrl', 'contentDisposition', contentDisposition);
316
319
  localVarPath = "/documentservice/v1/documents/signed-s3-url";
317
320
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
318
321
  if (configuration) {
@@ -332,6 +335,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
332
335
  if (s3Key !== undefined) {
333
336
  localVarQueryParameter['s3Key'] = s3Key;
334
337
  }
338
+ if (contentDisposition !== undefined) {
339
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
340
+ }
335
341
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
336
342
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
337
343
  }
@@ -570,16 +576,17 @@ var DocumentsApiFp = function (configuration) {
570
576
  * This will return a presigned URL for a random S3 key
571
577
  * @summary Fetches a presigned URL for a S3 key
572
578
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
579
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
573
580
  * @param {string} [authorization] Bearer Token
574
581
  * @param {*} [options] Override http request option.
575
582
  * @throws {RequiredError}
576
583
  */
577
- getSignedS3keyUrl: function (s3Key, authorization, options) {
584
+ getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
578
585
  return __awaiter(this, void 0, void 0, function () {
579
586
  var localVarAxiosArgs;
580
587
  return __generator(this, function (_a) {
581
588
  switch (_a.label) {
582
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options)];
589
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options)];
583
590
  case 1:
584
591
  localVarAxiosArgs = _a.sent();
585
592
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -695,12 +702,13 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
695
702
  * This will return a presigned URL for a random S3 key
696
703
  * @summary Fetches a presigned URL for a S3 key
697
704
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
705
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
698
706
  * @param {string} [authorization] Bearer Token
699
707
  * @param {*} [options] Override http request option.
700
708
  * @throws {RequiredError}
701
709
  */
702
- getSignedS3keyUrl: function (s3Key, authorization, options) {
703
- return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then(function (request) { return request(axios, basePath); });
710
+ getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
711
+ return localVarFp.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
704
712
  },
705
713
  /**
706
714
  * 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.
@@ -803,7 +811,7 @@ var DocumentsApi = /** @class */ (function (_super) {
803
811
  */
804
812
  DocumentsApi.prototype.getSignedS3keyUrl = function (requestParameters, options) {
805
813
  var _this = this;
806
- return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
814
+ return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
807
815
  };
808
816
  /**
809
817
  * 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.
@@ -12,6 +12,7 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { ListProductDocumentsResponseClass } from '../models';
15
16
  import { UploadProductDocumentRequestDto } from '../models';
16
17
  /**
17
18
  * ProductDocumentsApi - axios parameter creator
@@ -50,17 +51,17 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
50
51
  */
51
52
  getProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
53
  /**
53
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
54
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
54
55
  * @summary List product documents
55
56
  * @param {string} productSlug
56
57
  * @param {string} [authorization] Bearer Token
57
58
  * @param {number} [pageSize] Page size
58
59
  * @param {string} [pageToken] Page token
59
- * @param {string} [filter] List filter
60
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
60
61
  * @param {string} [search] Search query
61
- * @param {string} [order] Ordering criteria
62
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
62
63
  * @param {string} [expand] Extra fields to fetch
63
- * @param {string} [filters] List filters
64
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
64
65
  * @param {*} [options] Override http request option.
65
66
  * @throws {RequiredError}
66
67
  */
@@ -113,21 +114,21 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
113
114
  */
114
115
  getProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
115
116
  /**
116
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
117
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
117
118
  * @summary List product documents
118
119
  * @param {string} productSlug
119
120
  * @param {string} [authorization] Bearer Token
120
121
  * @param {number} [pageSize] Page size
121
122
  * @param {string} [pageToken] Page token
122
- * @param {string} [filter] List filter
123
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
123
124
  * @param {string} [search] Search query
124
- * @param {string} [order] Ordering criteria
125
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
125
126
  * @param {string} [expand] Extra fields to fetch
126
- * @param {string} [filters] List filters
127
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
127
128
  * @param {*} [options] Override http request option.
128
129
  * @throws {RequiredError}
129
130
  */
130
- listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
131
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
131
132
  /**
132
133
  * Upload a product document.
133
134
  * @summary Create the product document
@@ -176,21 +177,21 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
176
177
  */
177
178
  getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void>;
178
179
  /**
179
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
180
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
180
181
  * @summary List product documents
181
182
  * @param {string} productSlug
182
183
  * @param {string} [authorization] Bearer Token
183
184
  * @param {number} [pageSize] Page size
184
185
  * @param {string} [pageToken] Page token
185
- * @param {string} [filter] List filter
186
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
186
187
  * @param {string} [search] Search query
187
- * @param {string} [order] Ordering criteria
188
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
188
189
  * @param {string} [expand] Extra fields to fetch
189
- * @param {string} [filters] List filters
190
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
190
191
  * @param {*} [options] Override http request option.
191
192
  * @throws {RequiredError}
192
193
  */
193
- listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
194
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
194
195
  /**
195
196
  * Upload a product document.
196
197
  * @summary Create the product document
@@ -314,7 +315,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
314
315
  */
315
316
  readonly pageToken?: string;
316
317
  /**
317
- * List filter
318
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
318
319
  * @type {string}
319
320
  * @memberof ProductDocumentsApiListProductDocuments
320
321
  */
@@ -326,7 +327,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
326
327
  */
327
328
  readonly search?: string;
328
329
  /**
329
- * Ordering criteria
330
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
330
331
  * @type {string}
331
332
  * @memberof ProductDocumentsApiListProductDocuments
332
333
  */
@@ -338,7 +339,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
338
339
  */
339
340
  readonly expand?: string;
340
341
  /**
341
- * List filters
342
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
342
343
  * @type {string}
343
344
  * @memberof ProductDocumentsApiListProductDocuments
344
345
  */
@@ -404,14 +405,14 @@ export declare class ProductDocumentsApi extends BaseAPI {
404
405
  */
405
406
  getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
406
407
  /**
407
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
408
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
408
409
  * @summary List product documents
409
410
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
410
411
  * @param {*} [options] Override http request option.
411
412
  * @throws {RequiredError}
412
413
  * @memberof ProductDocumentsApi
413
414
  */
414
- listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
415
+ listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
415
416
  /**
416
417
  * Upload a product document.
417
418
  * @summary Create the product document
@@ -259,17 +259,17 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
259
259
  });
260
260
  },
261
261
  /**
262
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
262
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
263
263
  * @summary List product documents
264
264
  * @param {string} productSlug
265
265
  * @param {string} [authorization] Bearer Token
266
266
  * @param {number} [pageSize] Page size
267
267
  * @param {string} [pageToken] Page token
268
- * @param {string} [filter] List filter
268
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
269
269
  * @param {string} [search] Search query
270
- * @param {string} [order] Ordering criteria
270
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
271
271
  * @param {string} [expand] Extra fields to fetch
272
- * @param {string} [filters] List filters
272
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
273
273
  * @param {*} [options] Override http request option.
274
274
  * @throws {RequiredError}
275
275
  */
@@ -465,17 +465,17 @@ var ProductDocumentsApiFp = function (configuration) {
465
465
  });
466
466
  },
467
467
  /**
468
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
468
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
469
469
  * @summary List product documents
470
470
  * @param {string} productSlug
471
471
  * @param {string} [authorization] Bearer Token
472
472
  * @param {number} [pageSize] Page size
473
473
  * @param {string} [pageToken] Page token
474
- * @param {string} [filter] List filter
474
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
475
475
  * @param {string} [search] Search query
476
- * @param {string} [order] Ordering criteria
476
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
477
477
  * @param {string} [expand] Extra fields to fetch
478
- * @param {string} [filters] List filters
478
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
479
479
  * @param {*} [options] Override http request option.
480
480
  * @throws {RequiredError}
481
481
  */
@@ -562,17 +562,17 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
562
562
  return localVarFp.getProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
563
563
  },
564
564
  /**
565
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
565
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
566
566
  * @summary List product documents
567
567
  * @param {string} productSlug
568
568
  * @param {string} [authorization] Bearer Token
569
569
  * @param {number} [pageSize] Page size
570
570
  * @param {string} [pageToken] Page token
571
- * @param {string} [filter] List filter
571
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
572
572
  * @param {string} [search] Search query
573
- * @param {string} [order] Ordering criteria
573
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
574
574
  * @param {string} [expand] Extra fields to fetch
575
- * @param {string} [filters] List filters
575
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
576
576
  * @param {*} [options] Override http request option.
577
577
  * @throws {RequiredError}
578
578
  */
@@ -642,7 +642,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
642
642
  return (0, exports.ProductDocumentsApiFp)(this.configuration).getProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
643
643
  };
644
644
  /**
645
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
645
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
646
646
  * @summary List product documents
647
647
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
648
648
  * @param {*} [options] Override http request option.
@@ -9,10 +9,12 @@ export * from './delete-request-dto';
9
9
  export * from './get-layout-request-dto';
10
10
  export * from './inline-response200';
11
11
  export * from './inline-response503';
12
+ export * from './list-product-documents-response-class';
12
13
  export * from './list-request-dto';
13
14
  export * from './list-search-keywords-request-dto';
14
15
  export * from './list-searchable-document-owners-request-dto';
15
16
  export * from './list-searchable-documents-request-dto';
17
+ export * from './product-document-class';
16
18
  export * from './shared-update-docx-template-request-dto';
17
19
  export * from './update-doc-template-request-dto';
18
20
  export * from './update-document-request-dto';
@@ -25,10 +25,12 @@ __exportStar(require("./delete-request-dto"), exports);
25
25
  __exportStar(require("./get-layout-request-dto"), exports);
26
26
  __exportStar(require("./inline-response200"), exports);
27
27
  __exportStar(require("./inline-response503"), exports);
28
+ __exportStar(require("./list-product-documents-response-class"), exports);
28
29
  __exportStar(require("./list-request-dto"), exports);
29
30
  __exportStar(require("./list-search-keywords-request-dto"), exports);
30
31
  __exportStar(require("./list-searchable-document-owners-request-dto"), exports);
31
32
  __exportStar(require("./list-searchable-documents-request-dto"), exports);
33
+ __exportStar(require("./product-document-class"), exports);
32
34
  __exportStar(require("./shared-update-docx-template-request-dto"), exports);
33
35
  __exportStar(require("./update-doc-template-request-dto"), exports);
34
36
  __exportStar(require("./update-document-request-dto"), exports);
@@ -0,0 +1,31 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ProductDocumentClass } from './product-document-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ListProductDocumentsResponseClass
17
+ */
18
+ export interface ListProductDocumentsResponseClass {
19
+ /**
20
+ * The list of documents.
21
+ * @type {Array<ProductDocumentClass>}
22
+ * @memberof ListProductDocumentsResponseClass
23
+ */
24
+ 'items': Array<ProductDocumentClass>;
25
+ /**
26
+ * Next page token.
27
+ * @type {string}
28
+ * @memberof ListProductDocumentsResponseClass
29
+ */
30
+ 'nextPageToken': string;
31
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,117 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ProductDocumentClass
16
+ */
17
+ export interface ProductDocumentClass {
18
+ /**
19
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
20
+ * @type {number}
21
+ * @memberof ProductDocumentClass
22
+ */
23
+ 'id': number;
24
+ /**
25
+ * Unique identifier for the object.
26
+ * @type {string}
27
+ * @memberof ProductDocumentClass
28
+ */
29
+ 'code': string;
30
+ /**
31
+ * Unique identifier of the product that this object belongs to.
32
+ * @type {string}
33
+ * @memberof ProductDocumentClass
34
+ */
35
+ 'productCode': string;
36
+ /**
37
+ * Unique identifier referencing the product.
38
+ * @type {number}
39
+ * @memberof ProductDocumentClass
40
+ */
41
+ 'productVersionId': number;
42
+ /**
43
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
44
+ * @type {string}
45
+ * @memberof ProductDocumentClass
46
+ */
47
+ 'slug': string;
48
+ /**
49
+ * Type of the product document.
50
+ * @type {string}
51
+ * @memberof ProductDocumentClass
52
+ */
53
+ 'type': string;
54
+ /**
55
+ * Description of the document. Usually a short summary about the context in which the document is being used.
56
+ * @type {string}
57
+ * @memberof ProductDocumentClass
58
+ */
59
+ 'description': string;
60
+ /**
61
+ * The unique key used by Amazon Simple Storage Service (S3).
62
+ * @type {string}
63
+ * @memberof ProductDocumentClass
64
+ */
65
+ 's3Key': string;
66
+ /**
67
+ * Extension of the file.
68
+ * @type {string}
69
+ * @memberof ProductDocumentClass
70
+ */
71
+ 'contentType': ProductDocumentClassContentTypeEnum;
72
+ /**
73
+ * Product Document entity type.
74
+ * @type {string}
75
+ * @memberof ProductDocumentClass
76
+ */
77
+ 'entityType': string;
78
+ /**
79
+ * The file name the end user will see when downloading it.
80
+ * @type {string}
81
+ * @memberof ProductDocumentClass
82
+ */
83
+ 'filename': string;
84
+ /**
85
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
86
+ * @type {string}
87
+ * @memberof ProductDocumentClass
88
+ */
89
+ 'productSlug': string;
90
+ /**
91
+ * The current version number of the product document.
92
+ * @type {number}
93
+ * @memberof ProductDocumentClass
94
+ */
95
+ 'versionNumber': number;
96
+ /**
97
+ * Time at which the object was created.
98
+ * @type {string}
99
+ * @memberof ProductDocumentClass
100
+ */
101
+ 'createdAt': string;
102
+ /**
103
+ * Time at which the object was created.
104
+ * @type {string}
105
+ * @memberof ProductDocumentClass
106
+ */
107
+ 'updated': string;
108
+ }
109
+ export declare const ProductDocumentClassContentTypeEnum: {
110
+ readonly Pdf: "pdf";
111
+ readonly Jpg: "jpg";
112
+ readonly Png: "png";
113
+ readonly Csv: "csv";
114
+ readonly Doc: "doc";
115
+ readonly Docx: "docx";
116
+ };
117
+ export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ProductDocumentClassContentTypeEnum = void 0;
17
+ exports.ProductDocumentClassContentTypeEnum = {
18
+ Pdf: 'pdf',
19
+ Jpg: 'jpg',
20
+ Png: 'png',
21
+ Csv: 'csv',
22
+ Doc: 'doc',
23
+ Docx: 'docx'
24
+ };
package/models/index.ts CHANGED
@@ -9,10 +9,12 @@ export * from './delete-request-dto';
9
9
  export * from './get-layout-request-dto';
10
10
  export * from './inline-response200';
11
11
  export * from './inline-response503';
12
+ export * from './list-product-documents-response-class';
12
13
  export * from './list-request-dto';
13
14
  export * from './list-search-keywords-request-dto';
14
15
  export * from './list-searchable-document-owners-request-dto';
15
16
  export * from './list-searchable-documents-request-dto';
17
+ export * from './product-document-class';
16
18
  export * from './shared-update-docx-template-request-dto';
17
19
  export * from './update-doc-template-request-dto';
18
20
  export * from './update-document-request-dto';
@@ -0,0 +1,37 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { ProductDocumentClass } from './product-document-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface ListProductDocumentsResponseClass
22
+ */
23
+ export interface ListProductDocumentsResponseClass {
24
+ /**
25
+ * The list of documents.
26
+ * @type {Array<ProductDocumentClass>}
27
+ * @memberof ListProductDocumentsResponseClass
28
+ */
29
+ 'items': Array<ProductDocumentClass>;
30
+ /**
31
+ * Next page token.
32
+ * @type {string}
33
+ * @memberof ListProductDocumentsResponseClass
34
+ */
35
+ 'nextPageToken': string;
36
+ }
37
+
@@ -0,0 +1,126 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface ProductDocumentClass
21
+ */
22
+ export interface ProductDocumentClass {
23
+ /**
24
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
25
+ * @type {number}
26
+ * @memberof ProductDocumentClass
27
+ */
28
+ 'id': number;
29
+ /**
30
+ * Unique identifier for the object.
31
+ * @type {string}
32
+ * @memberof ProductDocumentClass
33
+ */
34
+ 'code': string;
35
+ /**
36
+ * Unique identifier of the product that this object belongs to.
37
+ * @type {string}
38
+ * @memberof ProductDocumentClass
39
+ */
40
+ 'productCode': string;
41
+ /**
42
+ * Unique identifier referencing the product.
43
+ * @type {number}
44
+ * @memberof ProductDocumentClass
45
+ */
46
+ 'productVersionId': number;
47
+ /**
48
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
49
+ * @type {string}
50
+ * @memberof ProductDocumentClass
51
+ */
52
+ 'slug': string;
53
+ /**
54
+ * Type of the product document.
55
+ * @type {string}
56
+ * @memberof ProductDocumentClass
57
+ */
58
+ 'type': string;
59
+ /**
60
+ * Description of the document. Usually a short summary about the context in which the document is being used.
61
+ * @type {string}
62
+ * @memberof ProductDocumentClass
63
+ */
64
+ 'description': string;
65
+ /**
66
+ * The unique key used by Amazon Simple Storage Service (S3).
67
+ * @type {string}
68
+ * @memberof ProductDocumentClass
69
+ */
70
+ 's3Key': string;
71
+ /**
72
+ * Extension of the file.
73
+ * @type {string}
74
+ * @memberof ProductDocumentClass
75
+ */
76
+ 'contentType': ProductDocumentClassContentTypeEnum;
77
+ /**
78
+ * Product Document entity type.
79
+ * @type {string}
80
+ * @memberof ProductDocumentClass
81
+ */
82
+ 'entityType': string;
83
+ /**
84
+ * The file name the end user will see when downloading it.
85
+ * @type {string}
86
+ * @memberof ProductDocumentClass
87
+ */
88
+ 'filename': string;
89
+ /**
90
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
91
+ * @type {string}
92
+ * @memberof ProductDocumentClass
93
+ */
94
+ 'productSlug': string;
95
+ /**
96
+ * The current version number of the product document.
97
+ * @type {number}
98
+ * @memberof ProductDocumentClass
99
+ */
100
+ 'versionNumber': number;
101
+ /**
102
+ * Time at which the object was created.
103
+ * @type {string}
104
+ * @memberof ProductDocumentClass
105
+ */
106
+ 'createdAt': string;
107
+ /**
108
+ * Time at which the object was created.
109
+ * @type {string}
110
+ * @memberof ProductDocumentClass
111
+ */
112
+ 'updated': string;
113
+ }
114
+
115
+ export const ProductDocumentClassContentTypeEnum = {
116
+ Pdf: 'pdf',
117
+ Jpg: 'jpg',
118
+ Png: 'png',
119
+ Csv: 'csv',
120
+ Doc: 'doc',
121
+ Docx: 'docx'
122
+ } as const;
123
+
124
+ export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];
125
+
126
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk-node",
3
- "version": "1.22.1-beta.2",
3
+ "version": "1.23.1-beta.0",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [