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

package/api/documents-api.ts

@@ -229,13 +229,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);
@@ -258,6 +261,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);
             }
@@ -463,12 +470,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);
         },
         /**
@@ -561,12 +569,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.
@@ -704,6 +713,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}
@@ -867,7 +883,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/base.ts

@@ -79,6 +79,7 @@ export class BaseAPI {
     protected configuration: Configuration;
     private username?: string;
     private password?: string;
+    private permissions: Array<string> = [];
 
     constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
         if (configuration) {
@@ -149,6 +150,10 @@ export class BaseAPI {
         this.configuration.basePath = env;
     }
 
+    getPermissions(): Array<string> {
+        return this.permissions;
+    }
+
     async authorize(username: string, password: string): Promise<void> {
         const options: AxiosRequestConfig = {
             method: 'POST',
@@ -163,20 +168,21 @@ export class BaseAPI {
 
         const response = await globalAxios.request<LoginClass>(options);
 
-        const { data: { accessToken } } = response;
+        const { data: { accessToken, permissions } } = response;
         this.configuration.username = username;
         this.configuration.accessToken = `Bearer ${accessToken}`;
+        this.permissions = permissions;
 
         const refreshToken = this.extractRefreshToken(response)
         this.configuration.refreshToken = refreshToken;
     }
 
-    async refreshTokenInternal(): Promise<string> {
+    async refreshTokenInternal(): Promise<LoginClass> {
         const { username, refreshToken } = this.configuration;
         
 
         if (!username || !refreshToken) {
-            return '';
+            throw new Error('Failed to refresh token.');
         }
 
         const options: AxiosRequestConfig = {
@@ -190,9 +196,9 @@ export class BaseAPI {
             withCredentials: true,
         };
 
-        const { data: { accessToken } } = await globalAxios.request<LoginClass>(options);
+        const response = await globalAxios.request<LoginClass>(options);
 
-        return accessToken;
+        return response.data;
     }
 
     private extractRefreshToken(response: AxiosResponse): string {
@@ -221,8 +227,9 @@ export class BaseAPI {
                     if (err.response.status === 401 && !originalConfig._retry) {
                         originalConfig._retry = true;
                         try {
-                            const tokenString = await this.refreshTokenInternal();
+                            const { accessToken: tokenString, permissions } = await this.refreshTokenInternal();
                             const accessToken = `Bearer ${tokenString}`;
+                            this.permissions = permissions;
 
                             originalConfig.headers['Authorization'] = `Bearer ${accessToken}`
 
@@ -246,8 +253,9 @@ export class BaseAPI {
                 ){ 
                     _retry_count++;
                     try {
-                        const tokenString = await this.refreshTokenInternal();
+                        const { accessToken: tokenString, permissions } = await this.refreshTokenInternal();
                         const accessToken = `Bearer ${tokenString}`;
+                        this.permissions = permissions;
 
                         _retry = true;
                         originalConfig.headers['Authorization'] = accessToken; 

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

@@ -298,11 +298,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;
@@ -311,6 +312,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) {
@@ -330,6 +333,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);
                             }
@@ -568,16 +574,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)];
@@ -693,12 +700,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.
@@ -801,7 +809,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/base.d.ts

@@ -53,14 +53,16 @@ export declare class BaseAPI {
     protected configuration: Configuration;
     private username?;
     private password?;
+    private permissions;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
     initialize(env?: Environment): Promise<void>;
     private loadCredentials;
     private readConfigFile;
     private readEnvVariables;
     selectEnvironment(env: Environment): void;
+    getPermissions(): Array<string>;
     authorize(username: string, password: string): Promise<void>;
-    refreshTokenInternal(): Promise<string>;
+    refreshTokenInternal(): Promise<LoginClass>;
     private extractRefreshToken;
     getConfiguration(): Configuration;
     private attachInterceptor;

package/dist/base.js

@@ -150,6 +150,7 @@ var BaseAPI = /** @class */ (function () {
         if (axios === void 0) { axios = axios_1.default; }
         this.basePath = basePath;
         this.axios = axios;
+        this.permissions = [];
         if (configuration) {
             this.configuration = configuration;
             this.basePath = configuration.basePath || this.basePath;
@@ -242,11 +243,14 @@ var BaseAPI = /** @class */ (function () {
     BaseAPI.prototype.selectEnvironment = function (env) {
         this.configuration.basePath = env;
     };
+    BaseAPI.prototype.getPermissions = function () {
+        return this.permissions;
+    };
     BaseAPI.prototype.authorize = function (username, password) {
         return __awaiter(this, void 0, void 0, function () {
-            var options, response, accessToken, refreshToken;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var options, response, _a, accessToken, permissions, refreshToken;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         options = {
                             method: 'POST',
@@ -260,10 +264,11 @@ var BaseAPI = /** @class */ (function () {
                         };
                         return [4 /*yield*/, axios_1.default.request(options)];
                     case 1:
-                        response = _a.sent();
-                        accessToken = response.data.accessToken;
+                        response = _b.sent();
+                        _a = response.data, accessToken = _a.accessToken, permissions = _a.permissions;
                         this.configuration.username = username;
                         this.configuration.accessToken = "Bearer ".concat(accessToken);
+                        this.permissions = permissions;
                         refreshToken = this.extractRefreshToken(response);
                         this.configuration.refreshToken = refreshToken;
                         return [2 /*return*/];
@@ -273,13 +278,13 @@ var BaseAPI = /** @class */ (function () {
     };
     BaseAPI.prototype.refreshTokenInternal = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, username, refreshToken, options, accessToken;
+            var _a, username, refreshToken, options, response;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         _a = this.configuration, username = _a.username, refreshToken = _a.refreshToken;
                         if (!username || !refreshToken) {
-                            return [2 /*return*/, ''];
+                            throw new Error('Failed to refresh token.');
                         }
                         options = {
                             method: 'POST',
@@ -293,8 +298,8 @@ var BaseAPI = /** @class */ (function () {
                         };
                         return [4 /*yield*/, axios_1.default.request(options)];
                     case 1:
-                        accessToken = (_b.sent()).data.accessToken;
-                        return [2 /*return*/, accessToken];
+                        response = _b.sent();
+                        return [2 /*return*/, response.data];
                 }
             });
         });
@@ -314,26 +319,27 @@ var BaseAPI = /** @class */ (function () {
         axios.interceptors.response.use(function (res) {
             return res;
         }, function (err) { return __awaiter(_this, void 0, void 0, function () {
-            var originalConfig, tokenString, accessToken, _error_1, tokenString, accessToken, _error_2;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var originalConfig, _a, tokenString, permissions, accessToken, _error_1, _b, tokenString, permissions, accessToken, _error_2;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         originalConfig = err.config;
                         if (!err.response) return [3 /*break*/, 5];
                         if (!(err.response.status === 401 && !originalConfig._retry)) return [3 /*break*/, 4];
                         originalConfig._retry = true;
-                        _a.label = 1;
+                        _c.label = 1;
                     case 1:
-                        _a.trys.push([1, 3, , 4]);
+                        _c.trys.push([1, 3, , 4]);
                         return [4 /*yield*/, this.refreshTokenInternal()];
                     case 2:
-                        tokenString = _a.sent();
+                        _a = _c.sent(), tokenString = _a.accessToken, permissions = _a.permissions;
                         accessToken = "Bearer ".concat(tokenString);
+                        this.permissions = permissions;
                         originalConfig.headers['Authorization'] = "Bearer ".concat(accessToken);
                         this.configuration.accessToken = accessToken;
                         return [2 /*return*/, axios.request(originalConfig)];
                     case 3:
-                        _error_1 = _a.sent();
+                        _error_1 = _c.sent();
                         if (_error_1.response && _error_1.response.data) {
                             return [2 /*return*/, Promise.reject(_error_1.response.data)];
                         }
@@ -349,19 +355,20 @@ var BaseAPI = /** @class */ (function () {
                             && originalConfig.headers.hasOwnProperty('Authorization')
                             && _retry_count < 4)) return [3 /*break*/, 9];
                         _retry_count++;
-                        _a.label = 6;
+                        _c.label = 6;
                     case 6:
-                        _a.trys.push([6, 8, , 9]);
+                        _c.trys.push([6, 8, , 9]);
                         return [4 /*yield*/, this.refreshTokenInternal()];
                     case 7:
-                        tokenString = _a.sent();
+                        _b = _c.sent(), tokenString = _b.accessToken, permissions = _b.permissions;
                         accessToken = "Bearer ".concat(tokenString);
+                        this.permissions = permissions;
                         _retry = true;
                         originalConfig.headers['Authorization'] = accessToken;
                         this.configuration.accessToken = accessToken;
                         return [2 /*return*/, axios.request(__assign({}, originalConfig))];
                     case 8:
-                        _error_2 = _a.sent();
+                        _error_2 = _c.sent();
                         if (_error_2.response && _error_2.response.data) {
                             return [2 /*return*/, Promise.reject(_error_2.response.data)];
                         }

package/package.json

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