@emilgroup/document-sdk 1.22.1-beta.1 → 1.22.1-beta.2

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