@emilgroup/document-sdk-node 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-node@1.25.0 --save
20
+ npm install @emilgroup/document-sdk-node@1.26.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk-node@1.25.0
24
+ yarn add @emilgroup/document-sdk-node@1.26.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -178,12 +178,13 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
178
178
  /**
179
179
  * This will return a presigned URL to download the document.
180
180
  * @summary Fetches a document download URL
181
- * @param {string} code
181
+ * @param {string} code Document code
182
182
  * @param {string} [authorization] Bearer Token
183
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
183
184
  * @param {*} [options] Override http request option.
184
185
  * @throws {RequiredError}
185
186
  */
186
- getDocumentDownloadUrl: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
187
+ getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
187
188
  // verify required parameter 'code' is not null or undefined
188
189
  assertParamExists('getDocumentDownloadUrl', 'code', code)
189
190
  const localVarPath = `/documentservice/v1/documents/{code}/download-url`
@@ -205,6 +206,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
205
206
  // http bearer authentication required
206
207
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
207
208
 
209
+ if (contentDisposition !== undefined) {
210
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
211
+ }
212
+
208
213
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
209
214
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
210
215
  }
@@ -444,13 +449,14 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
444
449
  /**
445
450
  * This will return a presigned URL to download the document.
446
451
  * @summary Fetches a document download URL
447
- * @param {string} code
452
+ * @param {string} code Document code
448
453
  * @param {string} [authorization] Bearer Token
454
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
449
455
  * @param {*} [options] Override http request option.
450
456
  * @throws {RequiredError}
451
457
  */
452
- async getDocumentDownloadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
453
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, options);
458
+ async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
459
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options);
454
460
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
455
461
  },
456
462
  /**
@@ -542,13 +548,14 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
542
548
  /**
543
549
  * This will return a presigned URL to download the document.
544
550
  * @summary Fetches a document download URL
545
- * @param {string} code
551
+ * @param {string} code Document code
546
552
  * @param {string} [authorization] Bearer Token
553
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
547
554
  * @param {*} [options] Override http request option.
548
555
  * @throws {RequiredError}
549
556
  */
550
- getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<void> {
551
- return localVarFp.getDocumentDownloadUrl(code, authorization, options).then((request) => request(axios, basePath));
557
+ getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void> {
558
+ return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
552
559
  },
553
560
  /**
554
561
  * This will return a presigned URL for a random S3 key
@@ -663,7 +670,7 @@ export interface DocumentsApiDeleteDocumentRequest {
663
670
  */
664
671
  export interface DocumentsApiGetDocumentDownloadUrlRequest {
665
672
  /**
666
- *
673
+ * Document code
667
674
  * @type {string}
668
675
  * @memberof DocumentsApiGetDocumentDownloadUrl
669
676
  */
@@ -675,6 +682,13 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
675
682
  * @memberof DocumentsApiGetDocumentDownloadUrl
676
683
  */
677
684
  readonly authorization?: string
685
+
686
+ /**
687
+ * Content disposition override. Default will be depending on the document type.
688
+ * @type {'attachment' | 'inline'}
689
+ * @memberof DocumentsApiGetDocumentDownloadUrl
690
+ */
691
+ readonly contentDisposition?: 'attachment' | 'inline'
678
692
  }
679
693
 
680
694
  /**
@@ -841,7 +855,7 @@ export class DocumentsApi extends BaseAPI {
841
855
  * @memberof DocumentsApi
842
856
  */
843
857
  public getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig) {
844
- return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
858
+ return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
845
859
  }
846
860
 
847
861
  /**
@@ -86,13 +86,14 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
86
86
  /**
87
87
  * Get a pre-signed download url for the given product document.
88
88
  * @summary Get pre-signed url for downloading product document
89
- * @param {string} productSlug
90
- * @param {string} code
89
+ * @param {string} productSlug Product slug
90
+ * @param {string} code Product document code
91
91
  * @param {string} [authorization] Bearer Token
92
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
92
93
  * @param {*} [options] Override http request option.
93
94
  * @throws {RequiredError}
94
95
  */
95
- downloadProductDocument: async (productSlug: string, code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
96
+ downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
96
97
  // verify required parameter 'productSlug' is not null or undefined
97
98
  assertParamExists('downloadProductDocument', 'productSlug', productSlug)
98
99
  // verify required parameter 'code' is not null or undefined
@@ -117,6 +118,10 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
117
118
  // http bearer authentication required
118
119
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
119
120
 
121
+ if (contentDisposition !== undefined) {
122
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
123
+ }
124
+
120
125
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
121
126
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
122
127
  }
@@ -338,14 +343,15 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
338
343
  /**
339
344
  * Get a pre-signed download url for the given product document.
340
345
  * @summary Get pre-signed url for downloading product document
341
- * @param {string} productSlug
342
- * @param {string} code
346
+ * @param {string} productSlug Product slug
347
+ * @param {string} code Product document code
343
348
  * @param {string} [authorization] Bearer Token
349
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
344
350
  * @param {*} [options] Override http request option.
345
351
  * @throws {RequiredError}
346
352
  */
347
- async downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
348
- const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options);
353
+ async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
354
+ const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options);
349
355
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
356
  },
351
357
  /**
@@ -418,14 +424,15 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
418
424
  /**
419
425
  * Get a pre-signed download url for the given product document.
420
426
  * @summary Get pre-signed url for downloading product document
421
- * @param {string} productSlug
422
- * @param {string} code
427
+ * @param {string} productSlug Product slug
428
+ * @param {string} code Product document code
423
429
  * @param {string} [authorization] Bearer Token
430
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
424
431
  * @param {*} [options] Override http request option.
425
432
  * @throws {RequiredError}
426
433
  */
427
- downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void> {
428
- return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
434
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void> {
435
+ return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
429
436
  },
430
437
  /**
431
438
  * Get a product document.
@@ -507,14 +514,14 @@ export interface ProductDocumentsApiDeleteProductDocumentRequest {
507
514
  */
508
515
  export interface ProductDocumentsApiDownloadProductDocumentRequest {
509
516
  /**
510
- *
517
+ * Product slug
511
518
  * @type {string}
512
519
  * @memberof ProductDocumentsApiDownloadProductDocument
513
520
  */
514
521
  readonly productSlug: string
515
522
 
516
523
  /**
517
- *
524
+ * Product document code
518
525
  * @type {string}
519
526
  * @memberof ProductDocumentsApiDownloadProductDocument
520
527
  */
@@ -526,6 +533,13 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
526
533
  * @memberof ProductDocumentsApiDownloadProductDocument
527
534
  */
528
535
  readonly authorization?: string
536
+
537
+ /**
538
+ * Content disposition override. Default will be depending on the document type.
539
+ * @type {'attachment' | 'inline'}
540
+ * @memberof ProductDocumentsApiDownloadProductDocument
541
+ */
542
+ readonly contentDisposition?: 'attachment' | 'inline'
529
543
  }
530
544
 
531
545
  /**
@@ -682,7 +696,7 @@ export class ProductDocumentsApi extends BaseAPI {
682
696
  * @memberof ProductDocumentsApi
683
697
  */
684
698
  public downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig) {
685
- return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
699
+ return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
686
700
  }
687
701
 
688
702
  /**
@@ -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.
@@ -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
249
  * @param {string} [authorization] Bearer Token
250
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
250
251
  * @param {*} [options] Override http request option.
251
252
  * @throws {RequiredError}
252
253
  */
253
- getDocumentDownloadUrl: function (code, authorization, options) {
254
+ getDocumentDownloadUrl: function (code, authorization, contentDisposition, 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;
@@ -276,6 +277,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
276
277
  // authentication bearer required
277
278
  // http bearer authentication required
278
279
  _a.sent();
280
+ if (contentDisposition !== undefined) {
281
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
282
+ }
279
283
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
280
284
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
281
285
  }
@@ -541,17 +545,18 @@ var DocumentsApiFp = function (configuration) {
541
545
  /**
542
546
  * This will return a presigned URL to download the document.
543
547
  * @summary Fetches a document download URL
544
- * @param {string} code
548
+ * @param {string} code Document code
545
549
  * @param {string} [authorization] Bearer Token
550
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
546
551
  * @param {*} [options] Override http request option.
547
552
  * @throws {RequiredError}
548
553
  */
549
- getDocumentDownloadUrl: function (code, authorization, options) {
554
+ getDocumentDownloadUrl: function (code, authorization, contentDisposition, options) {
550
555
  return __awaiter(this, void 0, void 0, function () {
551
556
  var localVarAxiosArgs;
552
557
  return __generator(this, function (_a) {
553
558
  switch (_a.label) {
554
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, options)];
559
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options)];
555
560
  case 1:
556
561
  localVarAxiosArgs = _a.sent();
557
562
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -675,13 +680,14 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
675
680
  /**
676
681
  * This will return a presigned URL to download the document.
677
682
  * @summary Fetches a document download URL
678
- * @param {string} code
683
+ * @param {string} code Document code
679
684
  * @param {string} [authorization] Bearer Token
685
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
680
686
  * @param {*} [options] Override http request option.
681
687
  * @throws {RequiredError}
682
688
  */
683
- getDocumentDownloadUrl: function (code, authorization, options) {
684
- return localVarFp.getDocumentDownloadUrl(code, authorization, options).then(function (request) { return request(axios, basePath); });
689
+ getDocumentDownloadUrl: function (code, authorization, contentDisposition, options) {
690
+ return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
685
691
  },
686
692
  /**
687
693
  * This will return a presigned URL for a random S3 key
@@ -783,7 +789,7 @@ var DocumentsApi = /** @class */ (function (_super) {
783
789
  */
784
790
  DocumentsApi.prototype.getDocumentDownloadUrl = function (requestParameters, options) {
785
791
  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); });
792
+ return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
787
793
  };
788
794
  /**
789
795
  * 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.
@@ -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
156
  * @param {string} [authorization] Bearer Token
157
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
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, authorization, contentDisposition, 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;
@@ -186,6 +187,9 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
186
187
  // authentication bearer required
187
188
  // http bearer authentication required
188
189
  _a.sent();
190
+ if (contentDisposition !== undefined) {
191
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
192
+ }
189
193
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
190
194
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
191
195
  }
@@ -416,18 +420,19 @@ var ProductDocumentsApiFp = function (configuration) {
416
420
  /**
417
421
  * Get a pre-signed download url for the given product document.
418
422
  * @summary Get pre-signed url for downloading product document
419
- * @param {string} productSlug
420
- * @param {string} code
423
+ * @param {string} productSlug Product slug
424
+ * @param {string} code Product document code
421
425
  * @param {string} [authorization] Bearer Token
426
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
422
427
  * @param {*} [options] Override http request option.
423
428
  * @throws {RequiredError}
424
429
  */
425
- downloadProductDocument: function (productSlug, code, authorization, options) {
430
+ downloadProductDocument: function (productSlug, code, authorization, contentDisposition, options) {
426
431
  return __awaiter(this, void 0, void 0, function () {
427
432
  var localVarAxiosArgs;
428
433
  return __generator(this, function (_a) {
429
434
  switch (_a.label) {
430
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options)];
435
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options)];
431
436
  case 1:
432
437
  localVarAxiosArgs = _a.sent();
433
438
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -532,14 +537,15 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
532
537
  /**
533
538
  * Get a pre-signed download url for the given product document.
534
539
  * @summary Get pre-signed url for downloading product document
535
- * @param {string} productSlug
536
- * @param {string} code
540
+ * @param {string} productSlug Product slug
541
+ * @param {string} code Product document code
537
542
  * @param {string} [authorization] Bearer Token
543
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
538
544
  * @param {*} [options] Override http request option.
539
545
  * @throws {RequiredError}
540
546
  */
541
- downloadProductDocument: function (productSlug, code, authorization, options) {
542
- return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
547
+ downloadProductDocument: function (productSlug, code, authorization, contentDisposition, options) {
548
+ return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
543
549
  },
544
550
  /**
545
551
  * Get a product document.
@@ -619,7 +625,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
619
625
  */
620
626
  ProductDocumentsApi.prototype.downloadProductDocument = function (requestParameters, options) {
621
627
  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); });
628
+ 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); });
623
629
  };
624
630
  /**
625
631
  * Get a product document.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk-node",
3
- "version": "1.25.0",
3
+ "version": "1.26.0",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [