@emilgroup/document-sdk-node 1.23.0 → 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.
@@ -245,12 +245,13 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
245
245
  /**
246
246
  * This will return a presigned URL to download the document.
247
247
  * @summary Fetches a document download URL
248
- * @param {string} code
248
+ * @param {string} code Document code
249
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
249
250
  * @param {string} [authorization] Bearer Token
250
251
  * @param {*} [options] Override http request option.
251
252
  * @throws {RequiredError}
252
253
  */
253
- getDocumentDownloadUrl: function (code, authorization, options) {
254
+ getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
254
255
  if (options === void 0) { options = {}; }
255
256
  return __awaiter(_this, void 0, void 0, function () {
256
257
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -259,6 +260,8 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
259
260
  case 0:
260
261
  // verify required parameter 'code' is not null or undefined
261
262
  (0, common_1.assertParamExists)('getDocumentDownloadUrl', 'code', code);
263
+ // verify required parameter 'contentDisposition' is not null or undefined
264
+ (0, common_1.assertParamExists)('getDocumentDownloadUrl', 'contentDisposition', contentDisposition);
262
265
  localVarPath = "/documentservice/v1/documents/{code}/download-url"
263
266
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
264
267
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -276,6 +279,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
276
279
  // authentication bearer required
277
280
  // http bearer authentication required
278
281
  _a.sent();
282
+ if (contentDisposition !== undefined) {
283
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
284
+ }
279
285
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
280
286
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
281
287
  }
@@ -294,11 +300,12 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
294
300
  * This will return a presigned URL for a random S3 key
295
301
  * @summary Fetches a presigned URL for a S3 key
296
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.
297
304
  * @param {string} [authorization] Bearer Token
298
305
  * @param {*} [options] Override http request option.
299
306
  * @throws {RequiredError}
300
307
  */
301
- getSignedS3keyUrl: function (s3Key, authorization, options) {
308
+ getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
302
309
  if (options === void 0) { options = {}; }
303
310
  return __awaiter(_this, void 0, void 0, function () {
304
311
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -307,6 +314,8 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
307
314
  case 0:
308
315
  // verify required parameter 's3Key' is not null or undefined
309
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);
310
319
  localVarPath = "/documentservice/v1/documents/signed-s3-url";
311
320
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
312
321
  if (configuration) {
@@ -326,6 +335,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
326
335
  if (s3Key !== undefined) {
327
336
  localVarQueryParameter['s3Key'] = s3Key;
328
337
  }
338
+ if (contentDisposition !== undefined) {
339
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
340
+ }
329
341
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
330
342
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
331
343
  }
@@ -541,17 +553,18 @@ var DocumentsApiFp = function (configuration) {
541
553
  /**
542
554
  * This will return a presigned URL to download the document.
543
555
  * @summary Fetches a document download URL
544
- * @param {string} code
556
+ * @param {string} code Document code
557
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
545
558
  * @param {string} [authorization] Bearer Token
546
559
  * @param {*} [options] Override http request option.
547
560
  * @throws {RequiredError}
548
561
  */
549
- getDocumentDownloadUrl: function (code, authorization, options) {
562
+ getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
550
563
  return __awaiter(this, void 0, void 0, function () {
551
564
  var localVarAxiosArgs;
552
565
  return __generator(this, function (_a) {
553
566
  switch (_a.label) {
554
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, options)];
567
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, contentDisposition, authorization, options)];
555
568
  case 1:
556
569
  localVarAxiosArgs = _a.sent();
557
570
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -563,16 +576,17 @@ var DocumentsApiFp = function (configuration) {
563
576
  * This will return a presigned URL for a random S3 key
564
577
  * @summary Fetches a presigned URL for a S3 key
565
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.
566
580
  * @param {string} [authorization] Bearer Token
567
581
  * @param {*} [options] Override http request option.
568
582
  * @throws {RequiredError}
569
583
  */
570
- getSignedS3keyUrl: function (s3Key, authorization, options) {
584
+ getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
571
585
  return __awaiter(this, void 0, void 0, function () {
572
586
  var localVarAxiosArgs;
573
587
  return __generator(this, function (_a) {
574
588
  switch (_a.label) {
575
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options)];
589
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options)];
576
590
  case 1:
577
591
  localVarAxiosArgs = _a.sent();
578
592
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -675,24 +689,26 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
675
689
  /**
676
690
  * This will return a presigned URL to download the document.
677
691
  * @summary Fetches a document download URL
678
- * @param {string} code
692
+ * @param {string} code Document code
693
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
679
694
  * @param {string} [authorization] Bearer Token
680
695
  * @param {*} [options] Override http request option.
681
696
  * @throws {RequiredError}
682
697
  */
683
- getDocumentDownloadUrl: function (code, authorization, options) {
684
- return localVarFp.getDocumentDownloadUrl(code, authorization, options).then(function (request) { return request(axios, basePath); });
698
+ getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
699
+ return localVarFp.getDocumentDownloadUrl(code, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
685
700
  },
686
701
  /**
687
702
  * This will return a presigned URL for a random S3 key
688
703
  * @summary Fetches a presigned URL for a S3 key
689
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.
690
706
  * @param {string} [authorization] Bearer Token
691
707
  * @param {*} [options] Override http request option.
692
708
  * @throws {RequiredError}
693
709
  */
694
- getSignedS3keyUrl: function (s3Key, authorization, options) {
695
- 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); });
696
712
  },
697
713
  /**
698
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.
@@ -783,7 +799,7 @@ var DocumentsApi = /** @class */ (function (_super) {
783
799
  */
784
800
  DocumentsApi.prototype.getDocumentDownloadUrl = function (requestParameters, options) {
785
801
  var _this = this;
786
- return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
802
+ return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
787
803
  };
788
804
  /**
789
805
  * This will return a presigned URL for a random S3 key
@@ -795,7 +811,7 @@ var DocumentsApi = /** @class */ (function (_super) {
795
811
  */
796
812
  DocumentsApi.prototype.getSignedS3keyUrl = function (requestParameters, options) {
797
813
  var _this = this;
798
- 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); });
799
815
  };
800
816
  /**
801
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
@@ -31,13 +32,14 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
31
32
  /**
32
33
  * Get a pre-signed download url for the given product document.
33
34
  * @summary Get pre-signed url for downloading product document
34
- * @param {string} productSlug
35
- * @param {string} code
35
+ * @param {string} productSlug Product slug
36
+ * @param {string} code Product document code
37
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
36
38
  * @param {string} [authorization] Bearer Token
37
39
  * @param {*} [options] Override http request option.
38
40
  * @throws {RequiredError}
39
41
  */
40
- downloadProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
+ downloadProductDocument: (productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
43
  /**
42
44
  * Get a product document.
43
45
  * @summary Retrieve the product document
@@ -49,17 +51,17 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
49
51
  */
50
52
  getProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51
53
  /**
52
- * 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.
53
55
  * @summary List product documents
54
56
  * @param {string} productSlug
55
57
  * @param {string} [authorization] Bearer Token
56
58
  * @param {number} [pageSize] Page size
57
59
  * @param {string} [pageToken] Page token
58
- * @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;
59
61
  * @param {string} [search] Search query
60
- * @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;
61
63
  * @param {string} [expand] Extra fields to fetch
62
- * @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;
63
65
  * @param {*} [options] Override http request option.
64
66
  * @throws {RequiredError}
65
67
  */
@@ -93,13 +95,14 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
93
95
  /**
94
96
  * Get a pre-signed download url for the given product document.
95
97
  * @summary Get pre-signed url for downloading product document
96
- * @param {string} productSlug
97
- * @param {string} code
98
+ * @param {string} productSlug Product slug
99
+ * @param {string} code Product document code
100
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
98
101
  * @param {string} [authorization] Bearer Token
99
102
  * @param {*} [options] Override http request option.
100
103
  * @throws {RequiredError}
101
104
  */
102
- downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
105
+ downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
103
106
  /**
104
107
  * Get a product document.
105
108
  * @summary Retrieve the product document
@@ -111,21 +114,21 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
111
114
  */
112
115
  getProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
113
116
  /**
114
- * 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.
115
118
  * @summary List product documents
116
119
  * @param {string} productSlug
117
120
  * @param {string} [authorization] Bearer Token
118
121
  * @param {number} [pageSize] Page size
119
122
  * @param {string} [pageToken] Page token
120
- * @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;
121
124
  * @param {string} [search] Search query
122
- * @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;
123
126
  * @param {string} [expand] Extra fields to fetch
124
- * @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;
125
128
  * @param {*} [options] Override http request option.
126
129
  * @throws {RequiredError}
127
130
  */
128
- 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>>;
129
132
  /**
130
133
  * Upload a product document.
131
134
  * @summary Create the product document
@@ -155,13 +158,14 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
155
158
  /**
156
159
  * Get a pre-signed download url for the given product document.
157
160
  * @summary Get pre-signed url for downloading product document
158
- * @param {string} productSlug
159
- * @param {string} code
161
+ * @param {string} productSlug Product slug
162
+ * @param {string} code Product document code
163
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
160
164
  * @param {string} [authorization] Bearer Token
161
165
  * @param {*} [options] Override http request option.
162
166
  * @throws {RequiredError}
163
167
  */
164
- downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void>;
168
+ downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
165
169
  /**
166
170
  * Get a product document.
167
171
  * @summary Retrieve the product document
@@ -173,21 +177,21 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
173
177
  */
174
178
  getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void>;
175
179
  /**
176
- * 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.
177
181
  * @summary List product documents
178
182
  * @param {string} productSlug
179
183
  * @param {string} [authorization] Bearer Token
180
184
  * @param {number} [pageSize] Page size
181
185
  * @param {string} [pageToken] Page token
182
- * @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;
183
187
  * @param {string} [search] Search query
184
- * @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;
185
189
  * @param {string} [expand] Extra fields to fetch
186
- * @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;
187
191
  * @param {*} [options] Override http request option.
188
192
  * @throws {RequiredError}
189
193
  */
190
- 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>;
191
195
  /**
192
196
  * Upload a product document.
193
197
  * @summary Create the product document
@@ -231,17 +235,23 @@ export interface ProductDocumentsApiDeleteProductDocumentRequest {
231
235
  */
232
236
  export interface ProductDocumentsApiDownloadProductDocumentRequest {
233
237
  /**
234
- *
238
+ * Product slug
235
239
  * @type {string}
236
240
  * @memberof ProductDocumentsApiDownloadProductDocument
237
241
  */
238
242
  readonly productSlug: string;
239
243
  /**
240
- *
244
+ * Product document code
241
245
  * @type {string}
242
246
  * @memberof ProductDocumentsApiDownloadProductDocument
243
247
  */
244
248
  readonly code: string;
249
+ /**
250
+ * Content disposition override. Default will be depending on the document type.
251
+ * @type {'attachment' | 'inline'}
252
+ * @memberof ProductDocumentsApiDownloadProductDocument
253
+ */
254
+ readonly contentDisposition: 'attachment' | 'inline';
245
255
  /**
246
256
  * Bearer Token
247
257
  * @type {string}
@@ -305,7 +315,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
305
315
  */
306
316
  readonly pageToken?: string;
307
317
  /**
308
- * 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;
309
319
  * @type {string}
310
320
  * @memberof ProductDocumentsApiListProductDocuments
311
321
  */
@@ -317,7 +327,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
317
327
  */
318
328
  readonly search?: string;
319
329
  /**
320
- * 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;
321
331
  * @type {string}
322
332
  * @memberof ProductDocumentsApiListProductDocuments
323
333
  */
@@ -329,7 +339,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
329
339
  */
330
340
  readonly expand?: string;
331
341
  /**
332
- * 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;
333
343
  * @type {string}
334
344
  * @memberof ProductDocumentsApiListProductDocuments
335
345
  */
@@ -395,14 +405,14 @@ export declare class ProductDocumentsApi extends BaseAPI {
395
405
  */
396
406
  getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
397
407
  /**
398
- * 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.
399
409
  * @summary List product documents
400
410
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
401
411
  * @param {*} [options] Override http request option.
402
412
  * @throws {RequiredError}
403
413
  * @memberof ProductDocumentsApi
404
414
  */
405
- listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
415
+ listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
406
416
  /**
407
417
  * Upload a product document.
408
418
  * @summary Create the product document
@@ -151,13 +151,14 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
151
151
  /**
152
152
  * Get a pre-signed download url for the given product document.
153
153
  * @summary Get pre-signed url for downloading product document
154
- * @param {string} productSlug
155
- * @param {string} code
154
+ * @param {string} productSlug Product slug
155
+ * @param {string} code Product document code
156
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
156
157
  * @param {string} [authorization] Bearer Token
157
158
  * @param {*} [options] Override http request option.
158
159
  * @throws {RequiredError}
159
160
  */
160
- downloadProductDocument: function (productSlug, code, authorization, options) {
161
+ downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
161
162
  if (options === void 0) { options = {}; }
162
163
  return __awaiter(_this, void 0, void 0, function () {
163
164
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -168,6 +169,8 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
168
169
  (0, common_1.assertParamExists)('downloadProductDocument', 'productSlug', productSlug);
169
170
  // verify required parameter 'code' is not null or undefined
170
171
  (0, common_1.assertParamExists)('downloadProductDocument', 'code', code);
172
+ // verify required parameter 'contentDisposition' is not null or undefined
173
+ (0, common_1.assertParamExists)('downloadProductDocument', 'contentDisposition', contentDisposition);
171
174
  localVarPath = "/documentservice/v1/product-documents/{productSlug}/{code}/download-url"
172
175
  .replace("{".concat("productSlug", "}"), encodeURIComponent(String(productSlug)))
173
176
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
@@ -186,6 +189,9 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
186
189
  // authentication bearer required
187
190
  // http bearer authentication required
188
191
  _a.sent();
192
+ if (contentDisposition !== undefined) {
193
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
194
+ }
189
195
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
190
196
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
191
197
  }
@@ -253,17 +259,17 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
253
259
  });
254
260
  },
255
261
  /**
256
- * 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.
257
263
  * @summary List product documents
258
264
  * @param {string} productSlug
259
265
  * @param {string} [authorization] Bearer Token
260
266
  * @param {number} [pageSize] Page size
261
267
  * @param {string} [pageToken] Page token
262
- * @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;
263
269
  * @param {string} [search] Search query
264
- * @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;
265
271
  * @param {string} [expand] Extra fields to fetch
266
- * @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;
267
273
  * @param {*} [options] Override http request option.
268
274
  * @throws {RequiredError}
269
275
  */
@@ -416,18 +422,19 @@ var ProductDocumentsApiFp = function (configuration) {
416
422
  /**
417
423
  * Get a pre-signed download url for the given product document.
418
424
  * @summary Get pre-signed url for downloading product document
419
- * @param {string} productSlug
420
- * @param {string} code
425
+ * @param {string} productSlug Product slug
426
+ * @param {string} code Product document code
427
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
421
428
  * @param {string} [authorization] Bearer Token
422
429
  * @param {*} [options] Override http request option.
423
430
  * @throws {RequiredError}
424
431
  */
425
- downloadProductDocument: function (productSlug, code, authorization, options) {
432
+ downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
426
433
  return __awaiter(this, void 0, void 0, function () {
427
434
  var localVarAxiosArgs;
428
435
  return __generator(this, function (_a) {
429
436
  switch (_a.label) {
430
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options)];
437
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, contentDisposition, authorization, options)];
431
438
  case 1:
432
439
  localVarAxiosArgs = _a.sent();
433
440
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -458,17 +465,17 @@ var ProductDocumentsApiFp = function (configuration) {
458
465
  });
459
466
  },
460
467
  /**
461
- * 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.
462
469
  * @summary List product documents
463
470
  * @param {string} productSlug
464
471
  * @param {string} [authorization] Bearer Token
465
472
  * @param {number} [pageSize] Page size
466
473
  * @param {string} [pageToken] Page token
467
- * @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;
468
475
  * @param {string} [search] Search query
469
- * @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;
470
477
  * @param {string} [expand] Extra fields to fetch
471
- * @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;
472
479
  * @param {*} [options] Override http request option.
473
480
  * @throws {RequiredError}
474
481
  */
@@ -532,14 +539,15 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
532
539
  /**
533
540
  * Get a pre-signed download url for the given product document.
534
541
  * @summary Get pre-signed url for downloading product document
535
- * @param {string} productSlug
536
- * @param {string} code
542
+ * @param {string} productSlug Product slug
543
+ * @param {string} code Product document code
544
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
537
545
  * @param {string} [authorization] Bearer Token
538
546
  * @param {*} [options] Override http request option.
539
547
  * @throws {RequiredError}
540
548
  */
541
- downloadProductDocument: function (productSlug, code, authorization, options) {
542
- return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
549
+ downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
550
+ return localVarFp.downloadProductDocument(productSlug, code, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
543
551
  },
544
552
  /**
545
553
  * Get a product document.
@@ -554,17 +562,17 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
554
562
  return localVarFp.getProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
555
563
  },
556
564
  /**
557
- * 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.
558
566
  * @summary List product documents
559
567
  * @param {string} productSlug
560
568
  * @param {string} [authorization] Bearer Token
561
569
  * @param {number} [pageSize] Page size
562
570
  * @param {string} [pageToken] Page token
563
- * @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;
564
572
  * @param {string} [search] Search query
565
- * @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;
566
574
  * @param {string} [expand] Extra fields to fetch
567
- * @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;
568
576
  * @param {*} [options] Override http request option.
569
577
  * @throws {RequiredError}
570
578
  */
@@ -619,7 +627,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
619
627
  */
620
628
  ProductDocumentsApi.prototype.downloadProductDocument = function (requestParameters, options) {
621
629
  var _this = this;
622
- return (0, exports.ProductDocumentsApiFp)(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
630
+ return (0, exports.ProductDocumentsApiFp)(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
623
631
  };
624
632
  /**
625
633
  * Get a product document.
@@ -634,7 +642,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
634
642
  return (0, exports.ProductDocumentsApiFp)(this.configuration).getProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
635
643
  };
636
644
  /**
637
- * 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.
638
646
  * @summary List product documents
639
647
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
640
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 });