@emilgroup/document-sdk 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.
@@ -241,12 +241,13 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
241
241
  /**
242
242
  * This will return a presigned URL to download the document.
243
243
  * @summary Fetches a document download URL
244
- * @param {string} code
244
+ * @param {string} code Document code
245
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
245
246
  * @param {string} [authorization] Bearer Token
246
247
  * @param {*} [options] Override http request option.
247
248
  * @throws {RequiredError}
248
249
  */
249
- getDocumentDownloadUrl: function (code, authorization, options) {
250
+ getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
250
251
  if (options === void 0) { options = {}; }
251
252
  return __awaiter(_this, void 0, void 0, function () {
252
253
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -255,6 +256,8 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
255
256
  case 0:
256
257
  // verify required parameter 'code' is not null or undefined
257
258
  (0, common_1.assertParamExists)('getDocumentDownloadUrl', 'code', code);
259
+ // verify required parameter 'contentDisposition' is not null or undefined
260
+ (0, common_1.assertParamExists)('getDocumentDownloadUrl', 'contentDisposition', contentDisposition);
258
261
  localVarPath = "/documentservice/v1/documents/{code}/download-url"
259
262
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
260
263
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -272,6 +275,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
272
275
  // authentication bearer required
273
276
  // http bearer authentication required
274
277
  _a.sent();
278
+ if (contentDisposition !== undefined) {
279
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
280
+ }
275
281
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
276
282
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
277
283
  }
@@ -290,11 +296,12 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
290
296
  * This will return a presigned URL for a random S3 key
291
297
  * @summary Fetches a presigned URL for a S3 key
292
298
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
299
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
293
300
  * @param {string} [authorization] Bearer Token
294
301
  * @param {*} [options] Override http request option.
295
302
  * @throws {RequiredError}
296
303
  */
297
- getSignedS3keyUrl: function (s3Key, authorization, options) {
304
+ getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
298
305
  if (options === void 0) { options = {}; }
299
306
  return __awaiter(_this, void 0, void 0, function () {
300
307
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -303,6 +310,8 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
303
310
  case 0:
304
311
  // verify required parameter 's3Key' is not null or undefined
305
312
  (0, common_1.assertParamExists)('getSignedS3keyUrl', 's3Key', s3Key);
313
+ // verify required parameter 'contentDisposition' is not null or undefined
314
+ (0, common_1.assertParamExists)('getSignedS3keyUrl', 'contentDisposition', contentDisposition);
306
315
  localVarPath = "/documentservice/v1/documents/signed-s3-url";
307
316
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
308
317
  if (configuration) {
@@ -322,6 +331,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
322
331
  if (s3Key !== undefined) {
323
332
  localVarQueryParameter['s3Key'] = s3Key;
324
333
  }
334
+ if (contentDisposition !== undefined) {
335
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
336
+ }
325
337
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
326
338
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
327
339
  }
@@ -537,17 +549,18 @@ var DocumentsApiFp = function (configuration) {
537
549
  /**
538
550
  * This will return a presigned URL to download the document.
539
551
  * @summary Fetches a document download URL
540
- * @param {string} code
552
+ * @param {string} code Document code
553
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
541
554
  * @param {string} [authorization] Bearer Token
542
555
  * @param {*} [options] Override http request option.
543
556
  * @throws {RequiredError}
544
557
  */
545
- getDocumentDownloadUrl: function (code, authorization, options) {
558
+ getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
546
559
  return __awaiter(this, void 0, void 0, function () {
547
560
  var localVarAxiosArgs;
548
561
  return __generator(this, function (_a) {
549
562
  switch (_a.label) {
550
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, options)];
563
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, contentDisposition, authorization, options)];
551
564
  case 1:
552
565
  localVarAxiosArgs = _a.sent();
553
566
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -559,16 +572,17 @@ var DocumentsApiFp = function (configuration) {
559
572
  * This will return a presigned URL for a random S3 key
560
573
  * @summary Fetches a presigned URL for a S3 key
561
574
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
575
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
562
576
  * @param {string} [authorization] Bearer Token
563
577
  * @param {*} [options] Override http request option.
564
578
  * @throws {RequiredError}
565
579
  */
566
- getSignedS3keyUrl: function (s3Key, authorization, options) {
580
+ getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
567
581
  return __awaiter(this, void 0, void 0, function () {
568
582
  var localVarAxiosArgs;
569
583
  return __generator(this, function (_a) {
570
584
  switch (_a.label) {
571
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options)];
585
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options)];
572
586
  case 1:
573
587
  localVarAxiosArgs = _a.sent();
574
588
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -671,24 +685,26 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
671
685
  /**
672
686
  * This will return a presigned URL to download the document.
673
687
  * @summary Fetches a document download URL
674
- * @param {string} code
688
+ * @param {string} code Document code
689
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
675
690
  * @param {string} [authorization] Bearer Token
676
691
  * @param {*} [options] Override http request option.
677
692
  * @throws {RequiredError}
678
693
  */
679
- getDocumentDownloadUrl: function (code, authorization, options) {
680
- return localVarFp.getDocumentDownloadUrl(code, authorization, options).then(function (request) { return request(axios, basePath); });
694
+ getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
695
+ return localVarFp.getDocumentDownloadUrl(code, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
681
696
  },
682
697
  /**
683
698
  * This will return a presigned URL for a random S3 key
684
699
  * @summary Fetches a presigned URL for a S3 key
685
700
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
701
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
686
702
  * @param {string} [authorization] Bearer Token
687
703
  * @param {*} [options] Override http request option.
688
704
  * @throws {RequiredError}
689
705
  */
690
- getSignedS3keyUrl: function (s3Key, authorization, options) {
691
- return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then(function (request) { return request(axios, basePath); });
706
+ getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
707
+ return localVarFp.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
692
708
  },
693
709
  /**
694
710
  * 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.
@@ -779,7 +795,7 @@ var DocumentsApi = /** @class */ (function (_super) {
779
795
  */
780
796
  DocumentsApi.prototype.getDocumentDownloadUrl = function (requestParameters, options) {
781
797
  var _this = this;
782
- return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
798
+ return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
783
799
  };
784
800
  /**
785
801
  * This will return a presigned URL for a random S3 key
@@ -791,7 +807,7 @@ var DocumentsApi = /** @class */ (function (_super) {
791
807
  */
792
808
  DocumentsApi.prototype.getSignedS3keyUrl = function (requestParameters, options) {
793
809
  var _this = this;
794
- return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
810
+ return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
795
811
  };
796
812
  /**
797
813
  * 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
@@ -147,13 +147,14 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
147
147
  /**
148
148
  * Get a pre-signed download url for the given product document.
149
149
  * @summary Get pre-signed url for downloading product document
150
- * @param {string} productSlug
151
- * @param {string} code
150
+ * @param {string} productSlug Product slug
151
+ * @param {string} code Product document code
152
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
152
153
  * @param {string} [authorization] Bearer Token
153
154
  * @param {*} [options] Override http request option.
154
155
  * @throws {RequiredError}
155
156
  */
156
- downloadProductDocument: function (productSlug, code, authorization, options) {
157
+ downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
157
158
  if (options === void 0) { options = {}; }
158
159
  return __awaiter(_this, void 0, void 0, function () {
159
160
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -164,6 +165,8 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
164
165
  (0, common_1.assertParamExists)('downloadProductDocument', 'productSlug', productSlug);
165
166
  // verify required parameter 'code' is not null or undefined
166
167
  (0, common_1.assertParamExists)('downloadProductDocument', 'code', code);
168
+ // verify required parameter 'contentDisposition' is not null or undefined
169
+ (0, common_1.assertParamExists)('downloadProductDocument', 'contentDisposition', contentDisposition);
167
170
  localVarPath = "/documentservice/v1/product-documents/{productSlug}/{code}/download-url"
168
171
  .replace("{".concat("productSlug", "}"), encodeURIComponent(String(productSlug)))
169
172
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
@@ -182,6 +185,9 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
182
185
  // authentication bearer required
183
186
  // http bearer authentication required
184
187
  _a.sent();
188
+ if (contentDisposition !== undefined) {
189
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
190
+ }
185
191
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
186
192
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
187
193
  }
@@ -249,17 +255,17 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
249
255
  });
250
256
  },
251
257
  /**
252
- * 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.
258
+ * 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.
253
259
  * @summary List product documents
254
260
  * @param {string} productSlug
255
261
  * @param {string} [authorization] Bearer Token
256
262
  * @param {number} [pageSize] Page size
257
263
  * @param {string} [pageToken] Page token
258
- * @param {string} [filter] List filter
264
+ * @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;
259
265
  * @param {string} [search] Search query
260
- * @param {string} [order] Ordering criteria
266
+ * @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;
261
267
  * @param {string} [expand] Extra fields to fetch
262
- * @param {string} [filters] List filters
268
+ * @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;
263
269
  * @param {*} [options] Override http request option.
264
270
  * @throws {RequiredError}
265
271
  */
@@ -412,18 +418,19 @@ var ProductDocumentsApiFp = function (configuration) {
412
418
  /**
413
419
  * Get a pre-signed download url for the given product document.
414
420
  * @summary Get pre-signed url for downloading product document
415
- * @param {string} productSlug
416
- * @param {string} code
421
+ * @param {string} productSlug Product slug
422
+ * @param {string} code Product document code
423
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
417
424
  * @param {string} [authorization] Bearer Token
418
425
  * @param {*} [options] Override http request option.
419
426
  * @throws {RequiredError}
420
427
  */
421
- downloadProductDocument: function (productSlug, code, authorization, options) {
428
+ downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
422
429
  return __awaiter(this, void 0, void 0, function () {
423
430
  var localVarAxiosArgs;
424
431
  return __generator(this, function (_a) {
425
432
  switch (_a.label) {
426
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options)];
433
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, contentDisposition, authorization, options)];
427
434
  case 1:
428
435
  localVarAxiosArgs = _a.sent();
429
436
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -454,17 +461,17 @@ var ProductDocumentsApiFp = function (configuration) {
454
461
  });
455
462
  },
456
463
  /**
457
- * 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.
464
+ * 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.
458
465
  * @summary List product documents
459
466
  * @param {string} productSlug
460
467
  * @param {string} [authorization] Bearer Token
461
468
  * @param {number} [pageSize] Page size
462
469
  * @param {string} [pageToken] Page token
463
- * @param {string} [filter] List filter
470
+ * @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;
464
471
  * @param {string} [search] Search query
465
- * @param {string} [order] Ordering criteria
472
+ * @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;
466
473
  * @param {string} [expand] Extra fields to fetch
467
- * @param {string} [filters] List filters
474
+ * @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;
468
475
  * @param {*} [options] Override http request option.
469
476
  * @throws {RequiredError}
470
477
  */
@@ -528,14 +535,15 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
528
535
  /**
529
536
  * Get a pre-signed download url for the given product document.
530
537
  * @summary Get pre-signed url for downloading product document
531
- * @param {string} productSlug
532
- * @param {string} code
538
+ * @param {string} productSlug Product slug
539
+ * @param {string} code Product document code
540
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
533
541
  * @param {string} [authorization] Bearer Token
534
542
  * @param {*} [options] Override http request option.
535
543
  * @throws {RequiredError}
536
544
  */
537
- downloadProductDocument: function (productSlug, code, authorization, options) {
538
- return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
545
+ downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
546
+ return localVarFp.downloadProductDocument(productSlug, code, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
539
547
  },
540
548
  /**
541
549
  * Get a product document.
@@ -550,17 +558,17 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
550
558
  return localVarFp.getProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
551
559
  },
552
560
  /**
553
- * 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.
561
+ * 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.
554
562
  * @summary List product documents
555
563
  * @param {string} productSlug
556
564
  * @param {string} [authorization] Bearer Token
557
565
  * @param {number} [pageSize] Page size
558
566
  * @param {string} [pageToken] Page token
559
- * @param {string} [filter] List filter
567
+ * @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;
560
568
  * @param {string} [search] Search query
561
- * @param {string} [order] Ordering criteria
569
+ * @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;
562
570
  * @param {string} [expand] Extra fields to fetch
563
- * @param {string} [filters] List filters
571
+ * @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;
564
572
  * @param {*} [options] Override http request option.
565
573
  * @throws {RequiredError}
566
574
  */
@@ -615,7 +623,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
615
623
  */
616
624
  ProductDocumentsApi.prototype.downloadProductDocument = function (requestParameters, options) {
617
625
  var _this = this;
618
- return (0, exports.ProductDocumentsApiFp)(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
626
+ 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); });
619
627
  };
620
628
  /**
621
629
  * Get a product document.
@@ -630,7 +638,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
630
638
  return (0, exports.ProductDocumentsApiFp)(this.configuration).getProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
631
639
  };
632
640
  /**
633
- * 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.
641
+ * 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.
634
642
  * @summary List product documents
635
643
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
636
644
  * @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 });