@emilgroup/document-sdk 1.26.0 → 1.27.0

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.26.0 --save
+npm install @emilgroup/document-sdk@1.27.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/document-sdk@1.26.0
+yarn add @emilgroup/document-sdk@1.27.0
 ```
 
 And then you can import `DocumentsApi`.

package/api/documents-api.ts

@@ -225,13 +225,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);
@@ -254,6 +257,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);
             }
@@ -459,12 +466,13 @@ export const DocumentsApiFp = function(configuration?: 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);
         },
         /**
@@ -557,12 +565,13 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
          * 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.
@@ -700,6 +709,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}
@@ -863,7 +879,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/dist/api/documents-api.d.ts

@@ -61,11 +61,12 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
      * 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
@@ -138,11 +139,12 @@ export declare const DocumentsApiFp: (configuration?: 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(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
@@ -215,11 +217,12 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
      * 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
@@ -340,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

@@ -294,11 +294,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 +308,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(localVarPath, common_1.DUMMY_BASE_URL);
                             if (configuration) {
@@ -326,6 +329,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);
                             }
@@ -564,16 +570,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)];
@@ -689,12 +696,13 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
          * 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.
@@ -797,7 +805,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/document-sdk",
-  "version": "1.26.0",
+  "version": "1.27.0",
   "description": "OpenAPI client for @emilgroup/document-sdk",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [