@emilgroup/document-sdk-node 1.23.0 → 1.23.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -29,10 +29,12 @@ models/get-layout-request-dto.ts
29
29
  models/index.ts
30
30
  models/inline-response200.ts
31
31
  models/inline-response503.ts
32
+ models/list-product-documents-response-class.ts
32
33
  models/list-request-dto.ts
33
34
  models/list-search-keywords-request-dto.ts
34
35
  models/list-searchable-document-owners-request-dto.ts
35
36
  models/list-searchable-documents-request-dto.ts
37
+ models/product-document-class.ts
36
38
  models/shared-update-docx-template-request-dto.ts
37
39
  models/update-doc-template-request-dto.ts
38
40
  models/update-document-request-dto.ts
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.23.0 --save
20
+ npm install @emilgroup/document-sdk-node@1.23.1-beta.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk-node@1.23.0
24
+ yarn add @emilgroup/document-sdk-node@1.23.1-beta.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -178,14 +178,17 @@ 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
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
182
183
  * @param {string} [authorization] Bearer Token
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, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
187
188
  // verify required parameter 'code' is not null or undefined
188
189
  assertParamExists('getDocumentDownloadUrl', 'code', code)
190
+ // verify required parameter 'contentDisposition' is not null or undefined
191
+ assertParamExists('getDocumentDownloadUrl', 'contentDisposition', contentDisposition)
189
192
  const localVarPath = `/documentservice/v1/documents/{code}/download-url`
190
193
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
191
194
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -205,6 +208,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
205
208
  // http bearer authentication required
206
209
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
207
210
 
211
+ if (contentDisposition !== undefined) {
212
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
213
+ }
214
+
208
215
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
209
216
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
210
217
  }
@@ -224,13 +231,16 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
224
231
  * This will return a presigned URL for a random S3 key
225
232
  * @summary Fetches a presigned URL for a S3 key
226
233
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
234
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
227
235
  * @param {string} [authorization] Bearer Token
228
236
  * @param {*} [options] Override http request option.
229
237
  * @throws {RequiredError}
230
238
  */
231
- getSignedS3keyUrl: async (s3Key: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
239
+ getSignedS3keyUrl: async (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
232
240
  // verify required parameter 's3Key' is not null or undefined
233
241
  assertParamExists('getSignedS3keyUrl', 's3Key', s3Key)
242
+ // verify required parameter 'contentDisposition' is not null or undefined
243
+ assertParamExists('getSignedS3keyUrl', 'contentDisposition', contentDisposition)
234
244
  const localVarPath = `/documentservice/v1/documents/signed-s3-url`;
235
245
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
236
246
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -253,6 +263,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
253
263
  localVarQueryParameter['s3Key'] = s3Key;
254
264
  }
255
265
 
266
+ if (contentDisposition !== undefined) {
267
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
268
+ }
269
+
256
270
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
257
271
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
258
272
  }
@@ -444,25 +458,27 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
444
458
  /**
445
459
  * This will return a presigned URL to download the document.
446
460
  * @summary Fetches a document download URL
447
- * @param {string} code
461
+ * @param {string} code Document code
462
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
448
463
  * @param {string} [authorization] Bearer Token
449
464
  * @param {*} [options] Override http request option.
450
465
  * @throws {RequiredError}
451
466
  */
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);
467
+ async getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
468
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, contentDisposition, authorization, options);
454
469
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
455
470
  },
456
471
  /**
457
472
  * This will return a presigned URL for a random S3 key
458
473
  * @summary Fetches a presigned URL for a S3 key
459
474
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
475
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
460
476
  * @param {string} [authorization] Bearer Token
461
477
  * @param {*} [options] Override http request option.
462
478
  * @throws {RequiredError}
463
479
  */
464
- async getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
465
- const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options);
480
+ async getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
481
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options);
466
482
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
467
483
  },
468
484
  /**
@@ -542,24 +558,26 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
542
558
  /**
543
559
  * This will return a presigned URL to download the document.
544
560
  * @summary Fetches a document download URL
545
- * @param {string} code
561
+ * @param {string} code Document code
562
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
546
563
  * @param {string} [authorization] Bearer Token
547
564
  * @param {*} [options] Override http request option.
548
565
  * @throws {RequiredError}
549
566
  */
550
- getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<void> {
551
- return localVarFp.getDocumentDownloadUrl(code, authorization, options).then((request) => request(axios, basePath));
567
+ getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
568
+ return localVarFp.getDocumentDownloadUrl(code, contentDisposition, authorization, options).then((request) => request(axios, basePath));
552
569
  },
553
570
  /**
554
571
  * This will return a presigned URL for a random S3 key
555
572
  * @summary Fetches a presigned URL for a S3 key
556
573
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
574
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
557
575
  * @param {string} [authorization] Bearer Token
558
576
  * @param {*} [options] Override http request option.
559
577
  * @throws {RequiredError}
560
578
  */
561
- getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void> {
562
- return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then((request) => request(axios, basePath));
579
+ getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
580
+ return localVarFp.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options).then((request) => request(axios, basePath));
563
581
  },
564
582
  /**
565
583
  * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
@@ -663,12 +681,19 @@ export interface DocumentsApiDeleteDocumentRequest {
663
681
  */
664
682
  export interface DocumentsApiGetDocumentDownloadUrlRequest {
665
683
  /**
666
- *
684
+ * Document code
667
685
  * @type {string}
668
686
  * @memberof DocumentsApiGetDocumentDownloadUrl
669
687
  */
670
688
  readonly code: string
671
689
 
690
+ /**
691
+ * Content disposition override. Default will be depending on the document type.
692
+ * @type {'attachment' | 'inline'}
693
+ * @memberof DocumentsApiGetDocumentDownloadUrl
694
+ */
695
+ readonly contentDisposition: 'attachment' | 'inline'
696
+
672
697
  /**
673
698
  * Bearer Token
674
699
  * @type {string}
@@ -690,6 +715,13 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
690
715
  */
691
716
  readonly s3Key: string
692
717
 
718
+ /**
719
+ * Content disposition override. Default will be depending on the document type.
720
+ * @type {'attachment' | 'inline'}
721
+ * @memberof DocumentsApiGetSignedS3keyUrl
722
+ */
723
+ readonly contentDisposition: 'attachment' | 'inline'
724
+
693
725
  /**
694
726
  * Bearer Token
695
727
  * @type {string}
@@ -841,7 +873,7 @@ export class DocumentsApi extends BaseAPI {
841
873
  * @memberof DocumentsApi
842
874
  */
843
875
  public getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig) {
844
- return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
876
+ return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
845
877
  }
846
878
 
847
879
  /**
@@ -853,7 +885,7 @@ export class DocumentsApi extends BaseAPI {
853
885
  * @memberof DocumentsApi
854
886
  */
855
887
  public getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig) {
856
- return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
888
+ return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
857
889
  }
858
890
 
859
891
  /**
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { ListProductDocumentsResponseClass } from '../models';
25
+ // @ts-ignore
24
26
  import { UploadProductDocumentRequestDto } from '../models';
25
27
  // URLSearchParams not necessarily used
26
28
  // @ts-ignore
@@ -84,17 +86,20 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
84
86
  /**
85
87
  * Get a pre-signed download url for the given product document.
86
88
  * @summary Get pre-signed url for downloading product document
87
- * @param {string} productSlug
88
- * @param {string} code
89
+ * @param {string} productSlug Product slug
90
+ * @param {string} code Product document code
91
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
89
92
  * @param {string} [authorization] Bearer Token
90
93
  * @param {*} [options] Override http request option.
91
94
  * @throws {RequiredError}
92
95
  */
93
- downloadProductDocument: async (productSlug: string, code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
96
+ downloadProductDocument: async (productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
94
97
  // verify required parameter 'productSlug' is not null or undefined
95
98
  assertParamExists('downloadProductDocument', 'productSlug', productSlug)
96
99
  // verify required parameter 'code' is not null or undefined
97
100
  assertParamExists('downloadProductDocument', 'code', code)
101
+ // verify required parameter 'contentDisposition' is not null or undefined
102
+ assertParamExists('downloadProductDocument', 'contentDisposition', contentDisposition)
98
103
  const localVarPath = `/documentservice/v1/product-documents/{productSlug}/{code}/download-url`
99
104
  .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)))
100
105
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
@@ -115,6 +120,10 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
115
120
  // http bearer authentication required
116
121
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
117
122
 
123
+ if (contentDisposition !== undefined) {
124
+ localVarQueryParameter['contentDisposition'] = contentDisposition;
125
+ }
126
+
118
127
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
119
128
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
120
129
  }
@@ -180,17 +189,17 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
180
189
  };
181
190
  },
182
191
  /**
183
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
192
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
184
193
  * @summary List product documents
185
194
  * @param {string} productSlug
186
195
  * @param {string} [authorization] Bearer Token
187
196
  * @param {number} [pageSize] Page size
188
197
  * @param {string} [pageToken] Page token
189
- * @param {string} [filter] List filter
198
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
190
199
  * @param {string} [search] Search query
191
- * @param {string} [order] Ordering criteria
200
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
192
201
  * @param {string} [expand] Extra fields to fetch
193
- * @param {string} [filters] List filters
202
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
194
203
  * @param {*} [options] Override http request option.
195
204
  * @throws {RequiredError}
196
205
  */
@@ -336,14 +345,15 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
336
345
  /**
337
346
  * Get a pre-signed download url for the given product document.
338
347
  * @summary Get pre-signed url for downloading product document
339
- * @param {string} productSlug
340
- * @param {string} code
348
+ * @param {string} productSlug Product slug
349
+ * @param {string} code Product document code
350
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
341
351
  * @param {string} [authorization] Bearer Token
342
352
  * @param {*} [options] Override http request option.
343
353
  * @throws {RequiredError}
344
354
  */
345
- async downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
346
- const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options);
355
+ async downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
356
+ const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, contentDisposition, authorization, options);
347
357
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
348
358
  },
349
359
  /**
@@ -360,21 +370,21 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
360
370
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
361
371
  },
362
372
  /**
363
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
373
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
364
374
  * @summary List product documents
365
375
  * @param {string} productSlug
366
376
  * @param {string} [authorization] Bearer Token
367
377
  * @param {number} [pageSize] Page size
368
378
  * @param {string} [pageToken] Page token
369
- * @param {string} [filter] List filter
379
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
370
380
  * @param {string} [search] Search query
371
- * @param {string} [order] Ordering criteria
381
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
372
382
  * @param {string} [expand] Extra fields to fetch
373
- * @param {string} [filters] List filters
383
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
374
384
  * @param {*} [options] Override http request option.
375
385
  * @throws {RequiredError}
376
386
  */
377
- async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
387
+ async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
378
388
  const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
379
389
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
380
390
  },
@@ -416,14 +426,15 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
416
426
  /**
417
427
  * Get a pre-signed download url for the given product document.
418
428
  * @summary Get pre-signed url for downloading product document
419
- * @param {string} productSlug
420
- * @param {string} code
429
+ * @param {string} productSlug Product slug
430
+ * @param {string} code Product document code
431
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
421
432
  * @param {string} [authorization] Bearer Token
422
433
  * @param {*} [options] Override http request option.
423
434
  * @throws {RequiredError}
424
435
  */
425
- downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void> {
426
- return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
436
+ downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
437
+ return localVarFp.downloadProductDocument(productSlug, code, contentDisposition, authorization, options).then((request) => request(axios, basePath));
427
438
  },
428
439
  /**
429
440
  * Get a product document.
@@ -438,21 +449,21 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
438
449
  return localVarFp.getProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
439
450
  },
440
451
  /**
441
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
452
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
442
453
  * @summary List product documents
443
454
  * @param {string} productSlug
444
455
  * @param {string} [authorization] Bearer Token
445
456
  * @param {number} [pageSize] Page size
446
457
  * @param {string} [pageToken] Page token
447
- * @param {string} [filter] List filter
458
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
448
459
  * @param {string} [search] Search query
449
- * @param {string} [order] Ordering criteria
460
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
450
461
  * @param {string} [expand] Extra fields to fetch
451
- * @param {string} [filters] List filters
462
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
452
463
  * @param {*} [options] Override http request option.
453
464
  * @throws {RequiredError}
454
465
  */
455
- listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
466
+ listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
456
467
  return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
457
468
  },
458
469
  /**
@@ -505,19 +516,26 @@ export interface ProductDocumentsApiDeleteProductDocumentRequest {
505
516
  */
506
517
  export interface ProductDocumentsApiDownloadProductDocumentRequest {
507
518
  /**
508
- *
519
+ * Product slug
509
520
  * @type {string}
510
521
  * @memberof ProductDocumentsApiDownloadProductDocument
511
522
  */
512
523
  readonly productSlug: string
513
524
 
514
525
  /**
515
- *
526
+ * Product document code
516
527
  * @type {string}
517
528
  * @memberof ProductDocumentsApiDownloadProductDocument
518
529
  */
519
530
  readonly code: string
520
531
 
532
+ /**
533
+ * Content disposition override. Default will be depending on the document type.
534
+ * @type {'attachment' | 'inline'}
535
+ * @memberof ProductDocumentsApiDownloadProductDocument
536
+ */
537
+ readonly contentDisposition: 'attachment' | 'inline'
538
+
521
539
  /**
522
540
  * Bearer Token
523
541
  * @type {string}
@@ -589,7 +607,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
589
607
  readonly pageToken?: string
590
608
 
591
609
  /**
592
- * List filter
610
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
593
611
  * @type {string}
594
612
  * @memberof ProductDocumentsApiListProductDocuments
595
613
  */
@@ -603,7 +621,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
603
621
  readonly search?: string
604
622
 
605
623
  /**
606
- * Ordering criteria
624
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, filename&lt;/i&gt;
607
625
  * @type {string}
608
626
  * @memberof ProductDocumentsApiListProductDocuments
609
627
  */
@@ -617,7 +635,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
617
635
  readonly expand?: string
618
636
 
619
637
  /**
620
- * List filters
638
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, productSlug, productCode, type, createdAt&lt;/i&gt;
621
639
  * @type {string}
622
640
  * @memberof ProductDocumentsApiListProductDocuments
623
641
  */
@@ -680,7 +698,7 @@ export class ProductDocumentsApi extends BaseAPI {
680
698
  * @memberof ProductDocumentsApi
681
699
  */
682
700
  public downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig) {
683
- return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
701
+ return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
684
702
  }
685
703
 
686
704
  /**
@@ -696,7 +714,7 @@ export class ProductDocumentsApi extends BaseAPI {
696
714
  }
697
715
 
698
716
  /**
699
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
717
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
700
718
  * @summary List product documents
701
719
  * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
702
720
  * @param {*} [options] Override http request option.
@@ -50,21 +50,23 @@ 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
62
63
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
64
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
63
65
  * @param {string} [authorization] Bearer Token
64
66
  * @param {*} [options] Override http request option.
65
67
  * @throws {RequiredError}
66
68
  */
67
- getSignedS3keyUrl: (s3Key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ getSignedS3keyUrl: (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
70
  /**
69
71
  * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
70
72
  * @summary List documents
@@ -126,21 +128,23 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
126
128
  /**
127
129
  * This will return a presigned URL to download the document.
128
130
  * @summary Fetches a document download URL
129
- * @param {string} code
131
+ * @param {string} code Document code
132
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
130
133
  * @param {string} [authorization] Bearer Token
131
134
  * @param {*} [options] Override http request option.
132
135
  * @throws {RequiredError}
133
136
  */
134
- getDocumentDownloadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
137
+ getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
135
138
  /**
136
139
  * This will return a presigned URL for a random S3 key
137
140
  * @summary Fetches a presigned URL for a S3 key
138
141
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
142
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
139
143
  * @param {string} [authorization] Bearer Token
140
144
  * @param {*} [options] Override http request option.
141
145
  * @throws {RequiredError}
142
146
  */
143
- getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
147
+ getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
144
148
  /**
145
149
  * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
146
150
  * @summary List documents
@@ -202,21 +206,23 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
202
206
  /**
203
207
  * This will return a presigned URL to download the document.
204
208
  * @summary Fetches a document download URL
205
- * @param {string} code
209
+ * @param {string} code Document code
210
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
206
211
  * @param {string} [authorization] Bearer Token
207
212
  * @param {*} [options] Override http request option.
208
213
  * @throws {RequiredError}
209
214
  */
210
- getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<void>;
215
+ getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
211
216
  /**
212
217
  * This will return a presigned URL for a random S3 key
213
218
  * @summary Fetches a presigned URL for a S3 key
214
219
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
220
+ * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
215
221
  * @param {string} [authorization] Bearer Token
216
222
  * @param {*} [options] Override http request option.
217
223
  * @throws {RequiredError}
218
224
  */
219
- getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void>;
225
+ getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
220
226
  /**
221
227
  * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
222
228
  * @summary List documents
@@ -307,11 +313,17 @@ export interface DocumentsApiDeleteDocumentRequest {
307
313
  */
308
314
  export interface DocumentsApiGetDocumentDownloadUrlRequest {
309
315
  /**
310
- *
316
+ * Document code
311
317
  * @type {string}
312
318
  * @memberof DocumentsApiGetDocumentDownloadUrl
313
319
  */
314
320
  readonly code: string;
321
+ /**
322
+ * Content disposition override. Default will be depending on the document type.
323
+ * @type {'attachment' | 'inline'}
324
+ * @memberof DocumentsApiGetDocumentDownloadUrl
325
+ */
326
+ readonly contentDisposition: 'attachment' | 'inline';
315
327
  /**
316
328
  * Bearer Token
317
329
  * @type {string}
@@ -331,6 +343,12 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
331
343
  * @memberof DocumentsApiGetSignedS3keyUrl
332
344
  */
333
345
  readonly s3Key: string;
346
+ /**
347
+ * Content disposition override. Default will be depending on the document type.
348
+ * @type {'attachment' | 'inline'}
349
+ * @memberof DocumentsApiGetSignedS3keyUrl
350
+ */
351
+ readonly contentDisposition: 'attachment' | 'inline';
334
352
  /**
335
353
  * Bearer Token
336
354
  * @type {string}