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

package/.openapi-generator/FILES

@@ -29,10 +29,12 @@ models/get-layout-request-dto.ts
 models/index.ts
 models/inline-response200.ts
 models/inline-response503.ts
+models/list-product-documents-response-class.ts
 models/list-request-dto.ts
 models/list-search-keywords-request-dto.ts
 models/list-searchable-document-owners-request-dto.ts
 models/list-searchable-documents-request-dto.ts
+models/product-document-class.ts
 models/shared-update-docx-template-request-dto.ts
 models/update-doc-template-request-dto.ts
 models/update-document-request-dto.ts

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/document-sdk@1.23.0 --save
+npm install @emilgroup/document-sdk@1.23.1-beta.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/document-sdk@1.23.0
+yarn add @emilgroup/document-sdk@1.23.1-beta.0
 ```
 
 And then you can import `DocumentsApi`.

package/api/documents-api.ts

@@ -174,14 +174,17 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
         /**
          * This will return a presigned URL to download the document.
          * @summary Fetches a document download URL
-         * @param {string} code 
+         * @param {string} code Document code
+         * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDocumentDownloadUrl: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getDocumentDownloadUrl: async (code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'code' is not null or undefined
             assertParamExists('getDocumentDownloadUrl', 'code', code)
+            // verify required parameter 'contentDisposition' is not null or undefined
+            assertParamExists('getDocumentDownloadUrl', 'contentDisposition', contentDisposition)
             const localVarPath = `/documentservice/v1/documents/{code}/download-url`
                 .replace(`{${"code"}}`, encodeURIComponent(String(code)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -201,6 +204,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
+            if (contentDisposition !== undefined) {
+                localVarQueryParameter['contentDisposition'] = contentDisposition;
+            }
+
             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
             }
@@ -220,13 +227,16 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
          * This will return a presigned URL for a random S3 key
          * @summary Fetches a presigned URL for a S3 key
          * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+         * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSignedS3keyUrl: async (s3Key: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getSignedS3keyUrl: async (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 's3Key' is not null or undefined
             assertParamExists('getSignedS3keyUrl', 's3Key', s3Key)
+            // verify required parameter 'contentDisposition' is not null or undefined
+            assertParamExists('getSignedS3keyUrl', 'contentDisposition', contentDisposition)
             const localVarPath = `/documentservice/v1/documents/signed-s3-url`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -249,6 +259,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
                 localVarQueryParameter['s3Key'] = s3Key;
             }
 
+            if (contentDisposition !== undefined) {
+                localVarQueryParameter['contentDisposition'] = contentDisposition;
+            }
+
             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
             }
@@ -440,25 +454,27 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
         /**
          * This will return a presigned URL to download the document.
          * @summary Fetches a document download URL
-         * @param {string} code 
+         * @param {string} code Document code
+         * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getDocumentDownloadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, options);
+        async getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, contentDisposition, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
          * This will return a presigned URL for a random S3 key
          * @summary Fetches a presigned URL for a S3 key
          * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+         * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options);
+        async getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -538,24 +554,26 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
         /**
          * This will return a presigned URL to download the document.
          * @summary Fetches a document download URL
-         * @param {string} code 
+         * @param {string} code Document code
+         * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<void> {
-            return localVarFp.getDocumentDownloadUrl(code, authorization, options).then((request) => request(axios, basePath));
+        getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.getDocumentDownloadUrl(code, contentDisposition, authorization, options).then((request) => request(axios, basePath));
         },
         /**
          * This will return a presigned URL for a random S3 key
          * @summary Fetches a presigned URL for a S3 key
          * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+         * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void> {
-            return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then((request) => request(axios, basePath));
+        getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options).then((request) => request(axios, basePath));
         },
         /**
          * 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.
@@ -659,12 +677,19 @@ export interface DocumentsApiDeleteDocumentRequest {
  */
 export interface DocumentsApiGetDocumentDownloadUrlRequest {
     /**
-     * 
+     * Document code
      * @type {string}
      * @memberof DocumentsApiGetDocumentDownloadUrl
      */
     readonly code: string
 
+    /**
+     * Content disposition override. Default will be depending on the document type.
+     * @type {'attachment' | 'inline'}
+     * @memberof DocumentsApiGetDocumentDownloadUrl
+     */
+    readonly contentDisposition: 'attachment' | 'inline'
+
     /**
      * Bearer Token
      * @type {string}
@@ -686,6 +711,13 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
      */
     readonly s3Key: string
 
+    /**
+     * Content disposition override. Default will be depending on the document type.
+     * @type {'attachment' | 'inline'}
+     * @memberof DocumentsApiGetSignedS3keyUrl
+     */
+    readonly contentDisposition: 'attachment' | 'inline'
+
     /**
      * Bearer Token
      * @type {string}
@@ -837,7 +869,7 @@ export class DocumentsApi extends BaseAPI {
      * @memberof DocumentsApi
      */
     public getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig) {
-        return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -849,7 +881,7 @@ export class DocumentsApi extends BaseAPI {
      * @memberof DocumentsApi
      */
     public getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig) {
-        return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/api/product-documents-api.ts

@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
+import { ListProductDocumentsResponseClass } from '../models';
+// @ts-ignore
 import { UploadProductDocumentRequestDto } from '../models';
 /**
  * ProductDocumentsApi - axios parameter creator
@@ -80,17 +82,20 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
         /**
          * Get a pre-signed download url for the given product document.
          * @summary Get pre-signed url for downloading product document
-         * @param {string} productSlug 
-         * @param {string} code 
+         * @param {string} productSlug Product slug
+         * @param {string} code Product document code
+         * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        downloadProductDocument: async (productSlug: string, code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        downloadProductDocument: async (productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'productSlug' is not null or undefined
             assertParamExists('downloadProductDocument', 'productSlug', productSlug)
             // verify required parameter 'code' is not null or undefined
             assertParamExists('downloadProductDocument', 'code', code)
+            // verify required parameter 'contentDisposition' is not null or undefined
+            assertParamExists('downloadProductDocument', 'contentDisposition', contentDisposition)
             const localVarPath = `/documentservice/v1/product-documents/{productSlug}/{code}/download-url`
                 .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)))
                 .replace(`{${"code"}}`, encodeURIComponent(String(code)));
@@ -111,6 +116,10 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
+            if (contentDisposition !== undefined) {
+                localVarQueryParameter['contentDisposition'] = contentDisposition;
+            }
+
             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
             }
@@ -176,17 +185,17 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
             };
         },
         /**
-         * 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.
+         * 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.
          * @summary List product documents
          * @param {string} productSlug 
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @param {string} [filter] List filter
+         * @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;
          * @param {string} [search] Search query
-         * @param {string} [order] Ordering criteria
+         * @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;
          * @param {string} [expand] Extra fields to fetch
-         * @param {string} [filters] List filters
+         * @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;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -332,14 +341,15 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
         /**
          * Get a pre-signed download url for the given product document.
          * @summary Get pre-signed url for downloading product document
-         * @param {string} productSlug 
-         * @param {string} code 
+         * @param {string} productSlug Product slug
+         * @param {string} code Product document code
+         * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options);
+        async downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, contentDisposition, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -356,21 +366,21 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 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.
+         * 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.
          * @summary List product documents
          * @param {string} productSlug 
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @param {string} [filter] List filter
+         * @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;
          * @param {string} [search] Search query
-         * @param {string} [order] Ordering criteria
+         * @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;
          * @param {string} [expand] Extra fields to fetch
-         * @param {string} [filters] List filters
+         * @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;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        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>> {
+        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>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -412,14 +422,15 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
         /**
          * Get a pre-signed download url for the given product document.
          * @summary Get pre-signed url for downloading product document
-         * @param {string} productSlug 
-         * @param {string} code 
+         * @param {string} productSlug Product slug
+         * @param {string} code Product document code
+         * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void> {
-            return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
+        downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
+            return localVarFp.downloadProductDocument(productSlug, code, contentDisposition, authorization, options).then((request) => request(axios, basePath));
         },
         /**
          * Get a product document.
@@ -434,21 +445,21 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
             return localVarFp.getProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 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.
+         * 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.
          * @summary List product documents
          * @param {string} productSlug 
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @param {string} [filter] List filter
+         * @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;
          * @param {string} [search] Search query
-         * @param {string} [order] Ordering criteria
+         * @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;
          * @param {string} [expand] Extra fields to fetch
-         * @param {string} [filters] List filters
+         * @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;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
+        listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
             return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
         /**
@@ -501,19 +512,26 @@ export interface ProductDocumentsApiDeleteProductDocumentRequest {
  */
 export interface ProductDocumentsApiDownloadProductDocumentRequest {
     /**
-     * 
+     * Product slug
      * @type {string}
      * @memberof ProductDocumentsApiDownloadProductDocument
      */
     readonly productSlug: string
 
     /**
-     * 
+     * Product document code
      * @type {string}
      * @memberof ProductDocumentsApiDownloadProductDocument
      */
     readonly code: string
 
+    /**
+     * Content disposition override. Default will be depending on the document type.
+     * @type {'attachment' | 'inline'}
+     * @memberof ProductDocumentsApiDownloadProductDocument
+     */
+    readonly contentDisposition: 'attachment' | 'inline'
+
     /**
      * Bearer Token
      * @type {string}
@@ -585,7 +603,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
     readonly pageToken?: string
 
     /**
-     * List 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;
      * @type {string}
      * @memberof ProductDocumentsApiListProductDocuments
      */
@@ -599,7 +617,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
     readonly search?: string
 
     /**
-     * Ordering criteria
+     * 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;
      * @type {string}
      * @memberof ProductDocumentsApiListProductDocuments
      */
@@ -613,7 +631,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
     readonly expand?: string
 
     /**
-     * List 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;
      * @type {string}
      * @memberof ProductDocumentsApiListProductDocuments
      */
@@ -676,7 +694,7 @@ export class ProductDocumentsApi extends BaseAPI {
      * @memberof ProductDocumentsApi
      */
     public downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig) {
-        return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -692,7 +710,7 @@ export class ProductDocumentsApi extends BaseAPI {
     }
 
     /**
-     * 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.
+     * 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.
      * @summary List product documents
      * @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/documents-api.d.ts

@@ -50,21 +50,23 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
     /**
      * This will return a presigned URL to download the document.
      * @summary Fetches a document download URL
-     * @param {string} code
+     * @param {string} code Document code
+     * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getDocumentDownloadUrl: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getDocumentDownloadUrl: (code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * This will return a presigned URL for a random S3 key
      * @summary Fetches a presigned URL for a S3 key
      * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+     * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSignedS3keyUrl: (s3Key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getSignedS3keyUrl: (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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.
      * @summary List documents
@@ -126,21 +128,23 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
     /**
      * This will return a presigned URL to download the document.
      * @summary Fetches a document download URL
-     * @param {string} code
+     * @param {string} code Document code
+     * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getDocumentDownloadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * This will return a presigned URL for a random S3 key
      * @summary Fetches a presigned URL for a S3 key
      * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+     * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * 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.
      * @summary List documents
@@ -202,21 +206,23 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
     /**
      * This will return a presigned URL to download the document.
      * @summary Fetches a document download URL
-     * @param {string} code
+     * @param {string} code Document code
+     * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
     /**
      * This will return a presigned URL for a random S3 key
      * @summary Fetches a presigned URL for a S3 key
      * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+     * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void>;
+    getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
     /**
      * 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.
      * @summary List documents
@@ -307,11 +313,17 @@ export interface DocumentsApiDeleteDocumentRequest {
  */
 export interface DocumentsApiGetDocumentDownloadUrlRequest {
     /**
-     *
+     * Document code
      * @type {string}
      * @memberof DocumentsApiGetDocumentDownloadUrl
      */
     readonly code: string;
+    /**
+     * Content disposition override. Default will be depending on the document type.
+     * @type {'attachment' | 'inline'}
+     * @memberof DocumentsApiGetDocumentDownloadUrl
+     */
+    readonly contentDisposition: 'attachment' | 'inline';
     /**
      * Bearer Token
      * @type {string}
@@ -331,6 +343,12 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
      * @memberof DocumentsApiGetSignedS3keyUrl
      */
     readonly s3Key: string;
+    /**
+     * Content disposition override. Default will be depending on the document type.
+     * @type {'attachment' | 'inline'}
+     * @memberof DocumentsApiGetSignedS3keyUrl
+     */
+    readonly contentDisposition: 'attachment' | 'inline';
     /**
      * Bearer Token
      * @type {string}