npm - @emilgroup/document-sdk-node - Versions diffs - 1.24.0 → 1.24.1-beta.0 - Mend

@emilgroup/document-sdk-node 1.24.0 → 1.24.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.

Files changed (8) hide show

package/README.md +2 -2
package/api/documents-api.ts +48 -16
package/api/product-documents-api.ts +38 -22
package/dist/api/documents-api.d.ts +28 -10
package/dist/api/documents-api.js +31 -15
package/dist/api/product-documents-api.d.ts +28 -19
package/dist/api/product-documents-api.js +26 -18
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -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-node@1.24.0 --save
+npm install @emilgroup/document-sdk-node@1.24.1-beta.0 --save
 ```
 or
 ```
-yarn add @emilgroup/document-sdk-node@1.24.0
+yarn add @emilgroup/document-sdk-node@1.24.1-beta.0
 ```
 And then you can import `DocumentsApi`.

package/api/documents-api.ts CHANGED Viewed

@@ -178,14 +178,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.
@@ -205,6 +208,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);
             }
@@ -224,13 +231,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);
@@ -253,6 +263,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);
             }
@@ -444,25 +458,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);
         },
         /**
@@ -542,24 +558,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.
@@ -663,12 +681,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}
@@ -690,6 +715,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}
@@ -841,7 +873,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));
     }
     /**
@@ -853,7 +885,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 CHANGED Viewed

@@ -86,17 +86,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)));
@@ -117,6 +120,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);
             }
@@ -188,11 +195,11 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @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} [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, slug&lt;/i&gt;
          * @param {string} [search] Search query
          * @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] 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 {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, slug&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -338,14 +345,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);
         },
         /**
@@ -368,11 +376,11 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @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} [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, slug&lt;/i&gt;
          * @param {string} [search] Search query
          * @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] 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 {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, slug&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -418,14 +426,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.
@@ -446,11 +455,11 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @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} [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, slug&lt;/i&gt;
          * @param {string} [search] Search query
          * @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] 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 {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, slug&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -507,19 +516,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}
@@ -591,7 +607,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
     readonly pageToken?: string
     /**
-     * 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;
+     * 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, slug&lt;/i&gt;
      * @type {string}
      * @memberof ProductDocumentsApiListProductDocuments
      */
@@ -619,7 +635,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
     readonly expand?: string
     /**
-     * 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;
+     * 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, slug&lt;/i&gt;
      * @type {string}
      * @memberof ProductDocumentsApiListProductDocuments
      */
@@ -682,7 +698,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));
     }
     /**

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

@@ -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}

package/dist/api/documents-api.js CHANGED Viewed

@@ -245,12 +245,13 @@ var DocumentsApiAxiosParamCreator = function (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: function (code, authorization, options) {
+        getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -259,6 +260,8 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
                         case 0:
                             // verify required parameter 'code' is not null or undefined
                             (0, common_1.assertParamExists)('getDocumentDownloadUrl', 'code', code);
+                            // verify required parameter 'contentDisposition' is not null or undefined
+                            (0, common_1.assertParamExists)('getDocumentDownloadUrl', 'contentDisposition', contentDisposition);
                             localVarPath = "/documentservice/v1/documents/{code}/download-url"
                                 .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
                             localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -276,6 +279,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
                             // authentication bearer required
                             // http bearer authentication required
                             _a.sent();
+                            if (contentDisposition !== undefined) {
+                                localVarQueryParameter['contentDisposition'] = contentDisposition;
+                            }
                             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
                             }
@@ -294,11 +300,12 @@ var DocumentsApiAxiosParamCreator = function (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}
          */
-        getSignedS3keyUrl: function (s3Key, authorization, options) {
+        getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -307,6 +314,8 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
                         case 0:
                             // verify required parameter 's3Key' is not null or undefined
                             (0, common_1.assertParamExists)('getSignedS3keyUrl', 's3Key', s3Key);
+                            // verify required parameter 'contentDisposition' is not null or undefined
+                            (0, common_1.assertParamExists)('getSignedS3keyUrl', 'contentDisposition', contentDisposition);
                             localVarPath = "/documentservice/v1/documents/signed-s3-url";
                             localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
                             if (configuration) {
@@ -326,6 +335,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
                             if (s3Key !== undefined) {
                                 localVarQueryParameter['s3Key'] = s3Key;
                             }
+                            if (contentDisposition !== undefined) {
+                                localVarQueryParameter['contentDisposition'] = contentDisposition;
+                            }
                             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
                             }
@@ -541,17 +553,18 @@ var DocumentsApiFp = function (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: function (code, authorization, options) {
+        getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, contentDisposition, authorization, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -563,16 +576,17 @@ var DocumentsApiFp = function (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}
          */
-        getSignedS3keyUrl: function (s3Key, authorization, options) {
+        getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -675,24 +689,26 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
         /**
          * 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: function (code, authorization, options) {
-            return localVarFp.getDocumentDownloadUrl(code, authorization, options).then(function (request) { return request(axios, basePath); });
+        getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
+            return localVarFp.getDocumentDownloadUrl(code, contentDisposition, authorization, options).then(function (request) { return 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: function (s3Key, authorization, options) {
-            return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then(function (request) { return request(axios, basePath); });
+        getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
+            return localVarFp.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options).then(function (request) { return 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.
@@ -783,7 +799,7 @@ var DocumentsApi = /** @class */ (function (_super) {
      */
     DocumentsApi.prototype.getDocumentDownloadUrl = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * This will return a presigned URL for a random S3 key
@@ -795,7 +811,7 @@ var DocumentsApi = /** @class */ (function (_super) {
      */
     DocumentsApi.prototype.getSignedS3keyUrl = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.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.

package/dist/api/product-documents-api.d.ts CHANGED Viewed

@@ -32,13 +32,14 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
     /**
      * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    downloadProductDocument: (productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a product document.
      * @summary Retrieve the product document
@@ -56,11 +57,11 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
      * @param {string} [authorization] Bearer Token
      * @param {number} [pageSize] Page size
      * @param {string} [pageToken] Page token
-     * @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} [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, slug&lt;/i&gt;
      * @param {string} [search] Search query
      * @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] 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 {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, slug&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -94,13 +95,14 @@ export declare const ProductDocumentsApiFp: (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}
      */
-    downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Get a product document.
      * @summary Retrieve the product document
@@ -118,11 +120,11 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
      * @param {string} [authorization] Bearer Token
      * @param {number} [pageSize] Page size
      * @param {string} [pageToken] Page token
-     * @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} [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, slug&lt;/i&gt;
      * @param {string} [search] Search query
      * @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] 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 {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, slug&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -156,13 +158,14 @@ export declare const ProductDocumentsApiFactory: (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}
      */
-    downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
     /**
      * Get a product document.
      * @summary Retrieve the product document
@@ -180,11 +183,11 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
      * @param {string} [authorization] Bearer Token
      * @param {number} [pageSize] Page size
      * @param {string} [pageToken] Page token
-     * @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} [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, slug&lt;/i&gt;
      * @param {string} [search] Search query
      * @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] 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 {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, slug&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -232,17 +235,23 @@ 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}
@@ -306,7 +315,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
      */
     readonly pageToken?: string;
     /**
-     * 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;
+     * 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, slug&lt;/i&gt;
      * @type {string}
      * @memberof ProductDocumentsApiListProductDocuments
      */
@@ -330,7 +339,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
      */
     readonly expand?: string;
     /**
-     * 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;
+     * 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, slug&lt;/i&gt;
      * @type {string}
      * @memberof ProductDocumentsApiListProductDocuments
      */

package/dist/api/product-documents-api.js CHANGED Viewed

@@ -151,13 +151,14 @@ var ProductDocumentsApiAxiosParamCreator = function (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}
          */
-        downloadProductDocument: function (productSlug, code, authorization, options) {
+        downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -168,6 +169,8 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
                             (0, common_1.assertParamExists)('downloadProductDocument', 'productSlug', productSlug);
                             // verify required parameter 'code' is not null or undefined
                             (0, common_1.assertParamExists)('downloadProductDocument', 'code', code);
+                            // verify required parameter 'contentDisposition' is not null or undefined
+                            (0, common_1.assertParamExists)('downloadProductDocument', 'contentDisposition', contentDisposition);
                             localVarPath = "/documentservice/v1/product-documents/{productSlug}/{code}/download-url"
                                 .replace("{".concat("productSlug", "}"), encodeURIComponent(String(productSlug)))
                                 .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
@@ -186,6 +189,9 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
                             // authentication bearer required
                             // http bearer authentication required
                             _a.sent();
+                            if (contentDisposition !== undefined) {
+                                localVarQueryParameter['contentDisposition'] = contentDisposition;
+                            }
                             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
                             }
@@ -259,11 +265,11 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @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} [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, slug&lt;/i&gt;
          * @param {string} [search] Search query
          * @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] 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 {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, slug&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -416,18 +422,19 @@ var ProductDocumentsApiFp = function (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}
          */
-        downloadProductDocument: function (productSlug, code, authorization, options) {
+        downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, contentDisposition, authorization, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -464,11 +471,11 @@ var ProductDocumentsApiFp = function (configuration) {
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @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} [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, slug&lt;/i&gt;
          * @param {string} [search] Search query
          * @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] 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 {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, slug&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -532,14 +539,15 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
         /**
          * 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: function (productSlug, code, authorization, options) {
-            return localVarFp.downloadProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
+        downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
+            return localVarFp.downloadProductDocument(productSlug, code, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Get a product document.
@@ -560,11 +568,11 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @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} [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, slug&lt;/i&gt;
          * @param {string} [search] Search query
          * @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] 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 {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, slug&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -619,7 +627,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
      */
     ProductDocumentsApi.prototype.downloadProductDocument = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.ProductDocumentsApiFp)(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        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); });
     };
     /**
      * Get a product document.

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/document-sdk-node",
-  "version": "1.24.0",
+  "version": "1.24.1-beta.0",
   "description": "OpenAPI client for @emilgroup/document-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [