@emilgroup/document-sdk 1.25.0 → 1.26.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.
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@1.25.0 --save
20
+ npm install @emilgroup/document-sdk@1.26.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk@1.25.0
24
+ yarn add @emilgroup/document-sdk@1.26.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -174,12 +174,13 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
174
174
  /**
175
175
  * This will return a presigned URL to download the document.
176
176
  * @summary Fetches a document download URL
177
- * @param {string} code
177
+ * @param {string} code Document code
178
178
  * @param {string} [authorization] Bearer Token
179
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
179
180
  * @param {*} [options] Override http request option.
180
181
  * @throws {RequiredError}
181
182
  */
182
- getDocumentDownloadUrl: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
183
+ getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
183
184
  // verify required parameter 'code' is not null or undefined
184
185
  assertParamExists('getDocumentDownloadUrl', 'code', code)
185
186
  const localVarPath = `/documentservice/v1/documents/{code}/download-url`
@@ -201,6 +202,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
201
202
  // http bearer authentication required
202
203
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
203
204
 
205
+ if (contentDisposition !== undefined) {
206
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
207
+ }
208
+
204
209
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
205
210
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
206
211
  }
@@ -440,13 +445,14 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
440
445
  /**
441
446
  * This will return a presigned URL to download the document.
442
447
  * @summary Fetches a document download URL
443
- * @param {string} code
448
+ * @param {string} code Document code
444
449
  * @param {string} [authorization] Bearer Token
450
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
445
451
  * @param {*} [options] Override http request option.
446
452
  * @throws {RequiredError}
447
453
  */
448
- async getDocumentDownloadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
449
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, options);
454
+ async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
455
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options);
450
456
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
451
457
  },
452
458
  /**
@@ -538,13 +544,14 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
538
544
  /**
539
545
  * This will return a presigned URL to download the document.
540
546
  * @summary Fetches a document download URL
541
- * @param {string} code
547
+ * @param {string} code Document code
542
548
  * @param {string} [authorization] Bearer Token
549
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
543
550
  * @param {*} [options] Override http request option.
544
551
  * @throws {RequiredError}
545
552
  */
546
- getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<void> {
547
- return localVarFp.getDocumentDownloadUrl(code, authorization, options).then((request) => request(axios, basePath));
553
+ getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void> {
554
+ return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
548
555
  },
549
556
  /**
550
557
  * This will return a presigned URL for a random S3 key
@@ -659,7 +666,7 @@ export interface DocumentsApiDeleteDocumentRequest {
659
666
  */
660
667
  export interface DocumentsApiGetDocumentDownloadUrlRequest {
661
668
  /**
662
- *
669
+ * Document code
663
670
  * @type {string}
664
671
  * @memberof DocumentsApiGetDocumentDownloadUrl
665
672
  */
@@ -671,6 +678,13 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
671
678
  * @memberof DocumentsApiGetDocumentDownloadUrl
672
679
  */
673
680
  readonly authorization?: string
681
+
682
+ /**
683
+ * Content disposition override. Default will be depending on the document type.
684
+ * @type {'attachment' | 'inline'}
685
+ * @memberof DocumentsApiGetDocumentDownloadUrl
686
+ */
687
+ readonly contentDisposition?: 'attachment' | 'inline'
674
688
  }
675
689
 
676
690
  /**
@@ -837,7 +851,7 @@ export class DocumentsApi extends BaseAPI {
837
851
  * @memberof DocumentsApi
838
852
  */
839
853
  public getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig) {
840
- return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
854
+ return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
841
855
  }
842
856
 
843
857
  /**
@@ -82,13 +82,14 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
82
82
  /**
83
83
  * Get a pre-signed download url for the given product document.
84
84
  * @summary Get pre-signed url for downloading product document
85
- * @param {string} productSlug
86
- * @param {string} code
85
+ * @param {string} productSlug Product slug
86
+ * @param {string} code Product document code
87
87
  * @param {string} [authorization] Bearer Token
88
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
88
89
  * @param {*} [options] Override http request option.
89
90
  * @throws {RequiredError}
90
91
  */
91
- downloadProductDocument: async (productSlug: string, code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
92
+ downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
92
93
  // verify required parameter 'productSlug' is not null or undefined
93
94
  assertParamExists('downloadProductDocument', 'productSlug', productSlug)
94
95
  // verify required parameter 'code' is not null or undefined
@@ -113,6 +114,10 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
113
114
  // http bearer authentication required
114
115
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
115
116
 
117
+ if (contentDisposition !== undefined) {
118
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
119
+ }
120
+
116
121
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
117
122
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
118
123
  }
@@ -334,14 +339,15 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
334
339
  /**
335
340
  * Get a pre-signed download url for the given product document.
336
341
  * @summary Get pre-signed url for downloading product document
337
- * @param {string} productSlug
338
- * @param {string} code
342
+ * @param {string} productSlug Product slug
343
+ * @param {string} code Product document code
339
344
  * @param {string} [authorization] Bearer Token
345
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
340
346
  * @param {*} [options] Override http request option.
341
347
  * @throws {RequiredError}
342
348
  */
343
- async downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
344
- const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options);
349
+ async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
350
+ const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options);
345
351
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
346
352
  },
347
353
  /**
@@ -414,14 +420,15 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
414
420
  /**
415
421
  * Get a pre-signed download url for the given product document.
416
422
  * @summary Get pre-signed url for downloading product document
417
- * @param {string} productSlug
418
- * @param {string} code
423
+ * @param {string} productSlug Product slug
424
+ * @param {string} code Product document code
419
425
  * @param {string} [authorization] Bearer Token
426
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
420
427
  * @param {*} [options] Override http request option.
421
428
  * @throws {RequiredError}
422
429
  */
423
- downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void> {
424
- return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
430
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void> {
431
+ return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
425
432
  },
426
433
  /**
427
434
  * Get a product document.
@@ -503,14 +510,14 @@ export interface ProductDocumentsApiDeleteProductDocumentRequest {
503
510
  */
504
511
  export interface ProductDocumentsApiDownloadProductDocumentRequest {
505
512
  /**
506
- *
513
+ * Product slug
507
514
  * @type {string}
508
515
  * @memberof ProductDocumentsApiDownloadProductDocument
509
516
  */
510
517
  readonly productSlug: string
511
518
 
512
519
  /**
513
- *
520
+ * Product document code
514
521
  * @type {string}
515
522
  * @memberof ProductDocumentsApiDownloadProductDocument
516
523
  */
@@ -522,6 +529,13 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
522
529
  * @memberof ProductDocumentsApiDownloadProductDocument
523
530
  */
524
531
  readonly authorization?: string
532
+
533
+ /**
534
+ * Content disposition override. Default will be depending on the document type.
535
+ * @type {'attachment' | 'inline'}
536
+ * @memberof ProductDocumentsApiDownloadProductDocument
537
+ */
538
+ readonly contentDisposition?: 'attachment' | 'inline'
525
539
  }
526
540
 
527
541
  /**
@@ -678,7 +692,7 @@ export class ProductDocumentsApi extends BaseAPI {
678
692
  * @memberof ProductDocumentsApi
679
693
  */
680
694
  public downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig) {
681
- return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
695
+ return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
682
696
  }
683
697
 
684
698
  /**
@@ -50,12 +50,13 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
50
50
  /**
51
51
  * This will return a presigned URL to download the document.
52
52
  * @summary Fetches a document download URL
53
- * @param {string} code
53
+ * @param {string} code Document code
54
54
  * @param {string} [authorization] Bearer Token
55
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
55
56
  * @param {*} [options] Override http request option.
56
57
  * @throws {RequiredError}
57
58
  */
58
- getDocumentDownloadUrl: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
59
+ getDocumentDownloadUrl: (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
59
60
  /**
60
61
  * This will return a presigned URL for a random S3 key
61
62
  * @summary Fetches a presigned URL for a S3 key
@@ -126,12 +127,13 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
126
127
  /**
127
128
  * This will return a presigned URL to download the document.
128
129
  * @summary Fetches a document download URL
129
- * @param {string} code
130
+ * @param {string} code Document code
130
131
  * @param {string} [authorization] Bearer Token
132
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
131
133
  * @param {*} [options] Override http request option.
132
134
  * @throws {RequiredError}
133
135
  */
134
- getDocumentDownloadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
136
+ getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
135
137
  /**
136
138
  * This will return a presigned URL for a random S3 key
137
139
  * @summary Fetches a presigned URL for a S3 key
@@ -202,12 +204,13 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
202
204
  /**
203
205
  * This will return a presigned URL to download the document.
204
206
  * @summary Fetches a document download URL
205
- * @param {string} code
207
+ * @param {string} code Document code
206
208
  * @param {string} [authorization] Bearer Token
209
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
207
210
  * @param {*} [options] Override http request option.
208
211
  * @throws {RequiredError}
209
212
  */
210
- getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<void>;
213
+ getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void>;
211
214
  /**
212
215
  * This will return a presigned URL for a random S3 key
213
216
  * @summary Fetches a presigned URL for a S3 key
@@ -307,7 +310,7 @@ export interface DocumentsApiDeleteDocumentRequest {
307
310
  */
308
311
  export interface DocumentsApiGetDocumentDownloadUrlRequest {
309
312
  /**
310
- *
313
+ * Document code
311
314
  * @type {string}
312
315
  * @memberof DocumentsApiGetDocumentDownloadUrl
313
316
  */
@@ -318,6 +321,12 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
318
321
  * @memberof DocumentsApiGetDocumentDownloadUrl
319
322
  */
320
323
  readonly authorization?: string;
324
+ /**
325
+ * Content disposition override. Default will be depending on the document type.
326
+ * @type {'attachment' | 'inline'}
327
+ * @memberof DocumentsApiGetDocumentDownloadUrl
328
+ */
329
+ readonly contentDisposition?: 'attachment' | 'inline';
321
330
  }
322
331
  /**
323
332
  * Request parameters for getSignedS3keyUrl operation in DocumentsApi.
@@ -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
245
  * @param {string} [authorization] Bearer Token
246
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
246
247
  * @param {*} [options] Override http request option.
247
248
  * @throws {RequiredError}
248
249
  */
249
- getDocumentDownloadUrl: function (code, authorization, options) {
250
+ getDocumentDownloadUrl: function (code, authorization, contentDisposition, 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;
@@ -272,6 +273,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
272
273
  // authentication bearer required
273
274
  // http bearer authentication required
274
275
  _a.sent();
276
+ if (contentDisposition !== undefined) {
277
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
278
+ }
275
279
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
276
280
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
277
281
  }
@@ -537,17 +541,18 @@ var DocumentsApiFp = function (configuration) {
537
541
  /**
538
542
  * This will return a presigned URL to download the document.
539
543
  * @summary Fetches a document download URL
540
- * @param {string} code
544
+ * @param {string} code Document code
541
545
  * @param {string} [authorization] Bearer Token
546
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
542
547
  * @param {*} [options] Override http request option.
543
548
  * @throws {RequiredError}
544
549
  */
545
- getDocumentDownloadUrl: function (code, authorization, options) {
550
+ getDocumentDownloadUrl: function (code, authorization, contentDisposition, options) {
546
551
  return __awaiter(this, void 0, void 0, function () {
547
552
  var localVarAxiosArgs;
548
553
  return __generator(this, function (_a) {
549
554
  switch (_a.label) {
550
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, options)];
555
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options)];
551
556
  case 1:
552
557
  localVarAxiosArgs = _a.sent();
553
558
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -671,13 +676,14 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
671
676
  /**
672
677
  * This will return a presigned URL to download the document.
673
678
  * @summary Fetches a document download URL
674
- * @param {string} code
679
+ * @param {string} code Document code
675
680
  * @param {string} [authorization] Bearer Token
681
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
676
682
  * @param {*} [options] Override http request option.
677
683
  * @throws {RequiredError}
678
684
  */
679
- getDocumentDownloadUrl: function (code, authorization, options) {
680
- return localVarFp.getDocumentDownloadUrl(code, authorization, options).then(function (request) { return request(axios, basePath); });
685
+ getDocumentDownloadUrl: function (code, authorization, contentDisposition, options) {
686
+ return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
681
687
  },
682
688
  /**
683
689
  * This will return a presigned URL for a random S3 key
@@ -779,7 +785,7 @@ var DocumentsApi = /** @class */ (function (_super) {
779
785
  */
780
786
  DocumentsApi.prototype.getDocumentDownloadUrl = function (requestParameters, options) {
781
787
  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); });
788
+ return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
783
789
  };
784
790
  /**
785
791
  * This will return a presigned URL for a random S3 key
@@ -32,13 +32,14 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
32
32
  /**
33
33
  * Get a pre-signed download url for the given product document.
34
34
  * @summary Get pre-signed url for downloading product document
35
- * @param {string} productSlug
36
- * @param {string} code
35
+ * @param {string} productSlug Product slug
36
+ * @param {string} code Product document code
37
37
  * @param {string} [authorization] Bearer Token
38
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
38
39
  * @param {*} [options] Override http request option.
39
40
  * @throws {RequiredError}
40
41
  */
41
- downloadProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
+ downloadProductDocument: (productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
43
  /**
43
44
  * Get a product document.
44
45
  * @summary Retrieve the product document
@@ -94,13 +95,14 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
94
95
  /**
95
96
  * Get a pre-signed download url for the given product document.
96
97
  * @summary Get pre-signed url for downloading product document
97
- * @param {string} productSlug
98
- * @param {string} code
98
+ * @param {string} productSlug Product slug
99
+ * @param {string} code Product document code
99
100
  * @param {string} [authorization] Bearer Token
101
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
100
102
  * @param {*} [options] Override http request option.
101
103
  * @throws {RequiredError}
102
104
  */
103
- downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
105
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
104
106
  /**
105
107
  * Get a product document.
106
108
  * @summary Retrieve the product document
@@ -156,13 +158,14 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
156
158
  /**
157
159
  * Get a pre-signed download url for the given product document.
158
160
  * @summary Get pre-signed url for downloading product document
159
- * @param {string} productSlug
160
- * @param {string} code
161
+ * @param {string} productSlug Product slug
162
+ * @param {string} code Product document code
161
163
  * @param {string} [authorization] Bearer Token
164
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
162
165
  * @param {*} [options] Override http request option.
163
166
  * @throws {RequiredError}
164
167
  */
165
- downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void>;
168
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void>;
166
169
  /**
167
170
  * Get a product document.
168
171
  * @summary Retrieve the product document
@@ -232,13 +235,13 @@ export interface ProductDocumentsApiDeleteProductDocumentRequest {
232
235
  */
233
236
  export interface ProductDocumentsApiDownloadProductDocumentRequest {
234
237
  /**
235
- *
238
+ * Product slug
236
239
  * @type {string}
237
240
  * @memberof ProductDocumentsApiDownloadProductDocument
238
241
  */
239
242
  readonly productSlug: string;
240
243
  /**
241
- *
244
+ * Product document code
242
245
  * @type {string}
243
246
  * @memberof ProductDocumentsApiDownloadProductDocument
244
247
  */
@@ -249,6 +252,12 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
249
252
  * @memberof ProductDocumentsApiDownloadProductDocument
250
253
  */
251
254
  readonly authorization?: string;
255
+ /**
256
+ * Content disposition override. Default will be depending on the document type.
257
+ * @type {'attachment' | 'inline'}
258
+ * @memberof ProductDocumentsApiDownloadProductDocument
259
+ */
260
+ readonly contentDisposition?: 'attachment' | 'inline';
252
261
  }
253
262
  /**
254
263
  * Request parameters for getProductDocument operation in ProductDocumentsApi.
@@ -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
152
  * @param {string} [authorization] Bearer Token
153
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
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, authorization, contentDisposition, 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;
@@ -182,6 +183,9 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
182
183
  // authentication bearer required
183
184
  // http bearer authentication required
184
185
  _a.sent();
186
+ if (contentDisposition !== undefined) {
187
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
188
+ }
185
189
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
186
190
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
187
191
  }
@@ -412,18 +416,19 @@ var ProductDocumentsApiFp = function (configuration) {
412
416
  /**
413
417
  * Get a pre-signed download url for the given product document.
414
418
  * @summary Get pre-signed url for downloading product document
415
- * @param {string} productSlug
416
- * @param {string} code
419
+ * @param {string} productSlug Product slug
420
+ * @param {string} code Product document code
417
421
  * @param {string} [authorization] Bearer Token
422
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
418
423
  * @param {*} [options] Override http request option.
419
424
  * @throws {RequiredError}
420
425
  */
421
- downloadProductDocument: function (productSlug, code, authorization, options) {
426
+ downloadProductDocument: function (productSlug, code, authorization, contentDisposition, options) {
422
427
  return __awaiter(this, void 0, void 0, function () {
423
428
  var localVarAxiosArgs;
424
429
  return __generator(this, function (_a) {
425
430
  switch (_a.label) {
426
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options)];
431
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options)];
427
432
  case 1:
428
433
  localVarAxiosArgs = _a.sent();
429
434
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -528,14 +533,15 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
528
533
  /**
529
534
  * Get a pre-signed download url for the given product document.
530
535
  * @summary Get pre-signed url for downloading product document
531
- * @param {string} productSlug
532
- * @param {string} code
536
+ * @param {string} productSlug Product slug
537
+ * @param {string} code Product document code
533
538
  * @param {string} [authorization] Bearer Token
539
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
534
540
  * @param {*} [options] Override http request option.
535
541
  * @throws {RequiredError}
536
542
  */
537
- downloadProductDocument: function (productSlug, code, authorization, options) {
538
- return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
543
+ downloadProductDocument: function (productSlug, code, authorization, contentDisposition, options) {
544
+ return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
539
545
  },
540
546
  /**
541
547
  * Get a product document.
@@ -615,7 +621,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
615
621
  */
616
622
  ProductDocumentsApi.prototype.downloadProductDocument = function (requestParameters, options) {
617
623
  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); });
624
+ return (0, exports.ProductDocumentsApiFp)(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
619
625
  };
620
626
  /**
621
627
  * Get a product document.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk",
3
- "version": "1.25.0",
3
+ "version": "1.26.0",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [