@emilgroup/document-sdk-node 1.22.0 → 1.22.1-beta.0

package/dist/api/document-templates-api.js

@@ -194,15 +194,15 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
+         * Retrieves the details of the document template that was previously created.        Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
          * @summary Retrieve the document template
          * @param {number} id
+         * @param {string} expand Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
          * @param {string} [authorization] Bearer Token
-         * @param {string} [expand] Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDocTemplate: function (id, authorization, expand, options) {
+        getDocTemplate: function (id, expand, authorization, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -211,6 +211,8 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
                         case 0:
                             // verify required parameter 'id' is not null or undefined
                             (0, common_1.assertParamExists)('getDocTemplate', 'id', id);
+                            // verify required parameter 'expand' is not null or undefined
+                            (0, common_1.assertParamExists)('getDocTemplate', 'expand', expand);
                             localVarPath = "/documentservice/v1/doc-templates/{id}"
                                 .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
                             localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -246,25 +248,37 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * Returns a list of document templates you have previously created.        The document templates are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
          * @summary List document templates
+         * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+         * @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
+         * @param {string} filter Filter response by productSlug, slug and name.
+         * @param {string} search Search document templates by name | slug
+         * @param {string} order Order response by createdAt.
+         * @param {string} expand Expand response by bodyTemplate.
          * @param {string} [authorization] Bearer Token
-         * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
-         * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter response by productSlug, slug and name.
-         * @param {string} [search] Search document templates by name | slug
-         * @param {string} [order] Order response by createdAt.
-         * @param {string} [expand] Expand response by bodyTemplate.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
+        listDocTemplates: function (pageSize, pageToken, filter, search, order, expand, authorization, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
+                            // verify required parameter 'pageSize' is not null or undefined
+                            (0, common_1.assertParamExists)('listDocTemplates', 'pageSize', pageSize);
+                            // verify required parameter 'pageToken' is not null or undefined
+                            (0, common_1.assertParamExists)('listDocTemplates', 'pageToken', pageToken);
+                            // verify required parameter 'filter' is not null or undefined
+                            (0, common_1.assertParamExists)('listDocTemplates', 'filter', filter);
+                            // verify required parameter 'search' is not null or undefined
+                            (0, common_1.assertParamExists)('listDocTemplates', 'search', search);
+                            // verify required parameter 'order' is not null or undefined
+                            (0, common_1.assertParamExists)('listDocTemplates', 'order', order);
+                            // verify required parameter 'expand' is not null or undefined
+                            (0, common_1.assertParamExists)('listDocTemplates', 'expand', expand);
                             localVarPath = "/documentservice/v1/doc-templates";
                             localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
                             if (configuration) {
@@ -419,20 +433,20 @@ var DocumentTemplatesApiFp = function (configuration) {
             });
         },
         /**
-         * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
+         * Retrieves the details of the document template that was previously created.        Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
          * @summary Retrieve the document template
          * @param {number} id
+         * @param {string} expand Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
          * @param {string} [authorization] Bearer Token
-         * @param {string} [expand] Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDocTemplate: function (id, authorization, expand, options) {
+        getDocTemplate: function (id, expand, 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.getDocTemplate(id, authorization, expand, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocTemplate(id, expand, authorization, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -441,24 +455,24 @@ var DocumentTemplatesApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * Returns a list of document templates you have previously created.        The document templates are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
          * @summary List document templates
+         * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+         * @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
+         * @param {string} filter Filter response by productSlug, slug and name.
+         * @param {string} search Search document templates by name | slug
+         * @param {string} order Order response by createdAt.
+         * @param {string} expand Expand response by bodyTemplate.
          * @param {string} [authorization] Bearer Token
-         * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
-         * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter response by productSlug, slug and name.
-         * @param {string} [search] Search document templates by name | slug
-         * @param {string} [order] Order response by createdAt.
-         * @param {string} [expand] Expand response by bodyTemplate.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
+        listDocTemplates: function (pageSize, pageToken, filter, search, order, expand, 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.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -521,32 +535,32 @@ var DocumentTemplatesApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteDocTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
+         * Retrieves the details of the document template that was previously created.        Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
          * @summary Retrieve the document template
          * @param {number} id
+         * @param {string} expand Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
          * @param {string} [authorization] Bearer Token
-         * @param {string} [expand] Use this parameter to fetch additional information about the list items.   The expand query parameter increases the set of fields that appear in the response in addition to the default ones.   Expanding resources can reduce the number of API calls required to accomplish a task. However,   use this with parsimony as some expanded fields can drastically increase payload size.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDocTemplate: function (id, authorization, expand, options) {
-            return localVarFp.getDocTemplate(id, authorization, expand, options).then(function (request) { return request(axios, basePath); });
+        getDocTemplate: function (id, expand, authorization, options) {
+            return localVarFp.getDocTemplate(id, expand, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * Returns a list of document templates you have previously created.        The document templates are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
          * @summary List document templates
+         * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+         * @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
+         * @param {string} filter Filter response by productSlug, slug and name.
+         * @param {string} search Search document templates by name | slug
+         * @param {string} order Order response by createdAt.
+         * @param {string} expand Expand response by bodyTemplate.
          * @param {string} [authorization] Bearer Token
-         * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
-         * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.   For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter response by productSlug, slug and name.
-         * @param {string} [search] Search document templates by name | slug
-         * @param {string} [order] Order response by createdAt.
-         * @param {string} [expand] Expand response by bodyTemplate.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
-            return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
+        listDocTemplates: function (pageSize, pageToken, filter, search, order, expand, authorization, options) {
+            return localVarFp.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -599,7 +613,7 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
         return (0, exports.DocumentTemplatesApiFp)(this.configuration).deleteDocTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
+     * Retrieves the details of the document template that was previously created.        Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
      * @summary Retrieve the document template
      * @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -608,10 +622,10 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
      */
     DocumentTemplatesApi.prototype.getDocTemplate = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.DocumentTemplatesApiFp)(this.configuration).getDocTemplate(requestParameters.id, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.DocumentTemplatesApiFp)(this.configuration).getDocTemplate(requestParameters.id, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of document templates you have previously created.        The document templates are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List document templates
      * @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -620,8 +634,7 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
      */
     DocumentTemplatesApi.prototype.listDocTemplates = function (requestParameters, options) {
         var _this = this;
-        if (requestParameters === void 0) { requestParameters = {}; }
-        return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

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

@@ -13,14 +13,8 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
 import { CreateDocumentRequestDto } from '../models';
-import { CreateDocumentSyncResponseClass } from '../models';
 import { CreatePresignedPostRequestDto } from '../models';
-import { CreatePresignedPostResponseClass } from '../models';
-import { GetDocumentDownloadUrlResponseClass } from '../models';
-import { GetSignedS3KeyUrlResponseClass } from '../models';
-import { ListDocumentsResponseClass } from '../models';
 import { UpdateDocumentRequestDto } from '../models';
-import { UpdateDocumentResponseClass } from '../models';
 /**
  * DocumentsApi - axios parameter creator
  * @export
@@ -56,12 +50,13 @@ 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
@@ -72,7 +67,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
      */
     getSignedS3keyUrl: (s3Key: string, 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.
+     * 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
      * @param {string} [authorization] Bearer Token
      * @param {number} [pageSize] Page size
@@ -110,7 +105,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocumentSyncResponseClass>>;
+    createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
      * @summary Upload documents using pre-signed URL
@@ -119,7 +114,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
+    createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
      * @summary Delete the document
@@ -128,16 +123,17 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * 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<GetDocumentDownloadUrlResponseClass>>;
+    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
@@ -146,9 +142,9 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignedS3KeyUrlResponseClass>>;
+    getSignedS3keyUrl(s3Key: string, 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.
+     * 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
      * @param {string} [authorization] Bearer Token
      * @param {number} [pageSize] Page size
@@ -161,7 +157,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
+    listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      * @summary Update the document
@@ -171,7 +167,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocumentResponseClass>>;
+    updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * DocumentsApi - factory interface
@@ -186,7 +182,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocumentSyncResponseClass>;
+    createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
     /**
      * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
      * @summary Upload documents using pre-signed URL
@@ -195,7 +191,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
+    createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
     /**
      * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
      * @summary Delete the document
@@ -204,16 +200,17 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<object>;
+    deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<void>;
     /**
      * 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<GetDocumentDownloadUrlResponseClass>;
+    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
@@ -222,9 +219,9 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass>;
+    getSignedS3keyUrl(s3Key: string, 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.
+     * 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
      * @param {string} [authorization] Bearer Token
      * @param {number} [pageSize] Page size
@@ -237,7 +234,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
+    listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
     /**
      * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      * @summary Update the document
@@ -247,7 +244,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocumentResponseClass>;
+    updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
 };
 /**
  * Request parameters for createDocument operation in DocumentsApi.
@@ -313,11 +310,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}
@@ -439,7 +442,7 @@ export declare class DocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DocumentsApi
      */
-    createDocument(requestParameters: DocumentsApiCreateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDocumentSyncResponseClass, any>>;
+    createDocument(requestParameters: DocumentsApiCreateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
      * @summary Upload documents using pre-signed URL
@@ -448,7 +451,7 @@ export declare class DocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DocumentsApi
      */
-    createPresignedPost(requestParameters: DocumentsApiCreatePresignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
+    createPresignedPost(requestParameters: DocumentsApiCreatePresignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
      * @summary Delete the document
@@ -457,7 +460,7 @@ export declare class DocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DocumentsApi
      */
-    deleteDocument(requestParameters: DocumentsApiDeleteDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    deleteDocument(requestParameters: DocumentsApiDeleteDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * This will return a presigned URL to download the document.
      * @summary Fetches a document download URL
@@ -466,7 +469,7 @@ export declare class DocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DocumentsApi
      */
-    getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocumentDownloadUrlResponseClass, any>>;
+    getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * This will return a presigned URL for a random S3 key
      * @summary Fetches a presigned URL for a S3 key
@@ -475,16 +478,16 @@ export declare class DocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DocumentsApi
      */
-    getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignedS3KeyUrlResponseClass, any>>;
+    getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * 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.
+     * 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
      * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentsApi
      */
-    listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
+    listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      * @summary Update the document
@@ -493,5 +496,5 @@ export declare class DocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DocumentsApi
      */
-    updateDocument(requestParameters: DocumentsApiUpdateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDocumentResponseClass, any>>;
+    updateDocument(requestParameters: DocumentsApiUpdateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }

package/dist/api/documents-api.js

@@ -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);
                             }
@@ -341,7 +347,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * 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.
+         * 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
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
@@ -541,17 +547,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)];
@@ -581,7 +588,7 @@ var DocumentsApiFp = function (configuration) {
             });
         },
         /**
-         * 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.
+         * 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
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
@@ -675,13 +682,14 @@ 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
@@ -695,7 +703,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getSignedS3keyUrl(s3Key, 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.
+         * 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
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
@@ -783,7 +791,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
@@ -798,7 +806,7 @@ var DocumentsApi = /** @class */ (function (_super) {
         return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, 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.
+     * 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
      * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.