@emilgroup/document-sdk-node 1.2.0 → 1.2.1

package/dist/api/documents-api.js

@@ -97,7 +97,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).        Document can then be downloaded with
+         * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).       Document can then be downloaded with
          * @summary Create the document
          * @param {CreateDocumentRequestDto} createDocumentRequestDto
          * @param {string} [authorization] Bearer Token
@@ -146,22 +146,23 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         *
-         * @param {CreateDocumentRequestDto} createDocumentRequestDto
+         * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
+         * @summary Upload documents using pre-signed URL
+         * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createTemporaryDocument: function (createDocumentRequestDto, authorization, options) {
+        createPresignedPost: function (createPresignedPostRequestDto, 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 'createDocumentRequestDto' is not null or undefined
-                            (0, common_1.assertParamExists)('createTemporaryDocument', 'createDocumentRequestDto', createDocumentRequestDto);
-                            localVarPath = "/documentservice/v1/documents/temporary";
+                            // verify required parameter 'createPresignedPostRequestDto' is not null or undefined
+                            (0, common_1.assertParamExists)('createPresignedPost', 'createPresignedPostRequestDto', createPresignedPostRequestDto);
+                            localVarPath = "/documentservice/v1/documents/pre-signed-post";
                             localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
                             if (configuration) {
                                 baseOptions = configuration.baseOptions;
@@ -184,7 +185,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
                             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
                             headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
                             localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-                            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createDocumentRequestDto, localVarRequestOptions, configuration);
+                            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPresignedPostRequestDto, localVarRequestOptions, configuration);
                             return [2 /*return*/, {
                                     url: (0, common_1.toPathString)(localVarUrlObj),
                                     options: localVarRequestOptions,
@@ -289,6 +290,56 @@ 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 {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSignedS3keyUrl: function (s3Key, 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 's3Key' is not null or undefined
+                            (0, common_1.assertParamExists)('getSignedS3keyUrl', 's3Key', s3Key);
+                            localVarPath = "/documentservice/v1/documents/signed-s3-url";
+                            localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+                            if (configuration) {
+                                baseOptions = configuration.baseOptions;
+                                baseAccessToken = configuration.accessToken;
+                            }
+                            localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                            localVarHeaderParameter = {};
+                            localVarQueryParameter = {};
+                            // authentication bearer required
+                            // http bearer authentication required
+                            return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
+                        case 1:
+                            // authentication bearer required
+                            // http bearer authentication required
+                            _a.sent();
+                            if (s3Key !== undefined) {
+                                localVarQueryParameter['s3Key'] = s3Key;
+                            }
+                            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+                            }
+                            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                            headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                            localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                            return [2 /*return*/, {
+                                    url: (0, common_1.toPathString)(localVarUrlObj),
+                                    options: localVarRequestOptions,
+                                }];
+                    }
+                });
+            });
+        },
         /**
          * 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
@@ -421,7 +472,7 @@ var DocumentsApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.DocumentsApiAxiosParamCreator)(configuration);
     return {
         /**
-         * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).        Document can then be downloaded with
+         * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).       Document can then be downloaded with
          * @summary Create the document
          * @param {CreateDocumentRequestDto} createDocumentRequestDto
          * @param {string} [authorization] Bearer Token
@@ -442,18 +493,19 @@ var DocumentsApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @param {CreateDocumentRequestDto} createDocumentRequestDto
+         * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
+         * @summary Upload documents using pre-signed URL
+         * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createTemporaryDocument: function (createDocumentRequestDto, authorization, options) {
+        createPresignedPost: function (createPresignedPostRequestDto, 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.createTemporaryDocument(createDocumentRequestDto, authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.createPresignedPost(createPresignedPostRequestDto, authorization, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -503,6 +555,27 @@ 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 {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSignedS3keyUrl: function (s3Key, 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 1:
+                            localVarAxiosArgs = _a.sent();
+                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, 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.
          * @summary List documents
@@ -562,7 +635,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.DocumentsApiFp)(configuration);
     return {
         /**
-         * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).        Document can then be downloaded with
+         * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).       Document can then be downloaded with
          * @summary Create the document
          * @param {CreateDocumentRequestDto} createDocumentRequestDto
          * @param {string} [authorization] Bearer Token
@@ -573,14 +646,15 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createDocument(createDocumentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         *
-         * @param {CreateDocumentRequestDto} createDocumentRequestDto
+         * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
+         * @summary Upload documents using pre-signed URL
+         * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createTemporaryDocument: function (createDocumentRequestDto, authorization, options) {
-            return localVarFp.createTemporaryDocument(createDocumentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
+        createPresignedPost: function (createPresignedPostRequestDto, authorization, options) {
+            return localVarFp.createPresignedPost(createPresignedPostRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
@@ -604,6 +678,17 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
         getDocumentDownloadUrl: function (code, authorization, options) {
             return localVarFp.getDocumentDownloadUrl(code, authorization, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * This will return a presigned URL for a random S3 key
+         * @summary Fetches a presigned URL for a S3 key
+         * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+         * @param {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); });
+        },
         /**
          * 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
@@ -647,7 +732,7 @@ var DocumentsApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).        Document can then be downloaded with
+     * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).       Document can then be downloaded with
      * @summary Create the document
      * @param {DocumentsApiCreateDocumentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -659,15 +744,16 @@ var DocumentsApi = /** @class */ (function (_super) {
         return (0, exports.DocumentsApiFp)(this.configuration).createDocument(requestParameters.createDocumentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     *
-     * @param {DocumentsApiCreateTemporaryDocumentRequest} requestParameters Request parameters.
+     * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
+     * @summary Upload documents using pre-signed URL
+     * @param {DocumentsApiCreatePresignedPostRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentsApi
      */
-    DocumentsApi.prototype.createTemporaryDocument = function (requestParameters, options) {
+    DocumentsApi.prototype.createPresignedPost = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.DocumentsApiFp)(this.configuration).createTemporaryDocument(requestParameters.createDocumentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.DocumentsApiFp)(this.configuration).createPresignedPost(requestParameters.createPresignedPostRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
@@ -693,6 +779,18 @@ var DocumentsApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * This will return a presigned URL for a random S3 key
+     * @summary Fetches a presigned URL for a S3 key
+     * @param {DocumentsApiGetSignedS3keyUrlRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    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); });
+    };
     /**
      * 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

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

@@ -13,6 +13,8 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
 import { CreateLayoutRequestDto } from '../models';
+import { CreateLayoutResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
 import { GetLayoutResponseClass } from '../models';
 import { ListLayoutsResponseClass } from '../models';
 import { UpdateLayoutRequestDto } from '../models';
@@ -23,7 +25,8 @@ import { UpdateLayoutResponseClass } from '../models';
  */
 export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *
+     * This will create a layout.
+     * @summary Create the layout
      * @param {CreateLayoutRequestDto} createLayoutRequestDto
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
@@ -31,7 +34,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
      */
     createLayout: (createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+     * @summary Delete the layout
      * @param {number} id
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
@@ -39,16 +43,18 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
      */
     deleteLayout: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+     * @summary Retrieve the layout
      * @param {string} id
-     * @param {number} id2 Layout id
+     * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getLayout: (id: string, id2: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List layouts
      * @param {string} [authorization] Bearer Token
      * @param {number} [pageSize] Page size
      * @param {string} [pageToken] Page token
@@ -61,7 +67,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
      */
     listLayouts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the layout
      * @param {number} id
      * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
      * @param {string} [authorization] Bearer Token
@@ -76,32 +83,36 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
  */
 export declare const LayoutsApiFp: (configuration?: Configuration) => {
     /**
-     *
+     * This will create a layout.
+     * @summary Create the layout
      * @param {CreateLayoutRequestDto} createLayoutRequestDto
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>>;
     /**
-     *
+     * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+     * @summary Delete the layout
      * @param {number} id
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
     /**
-     *
+     * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+     * @summary Retrieve the layout
      * @param {string} id
-     * @param {number} id2 Layout id
+     * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getLayout(id: string, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>>;
     /**
-     *
+     * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List layouts
      * @param {string} [authorization] Bearer Token
      * @param {number} [pageSize] Page size
      * @param {string} [pageToken] Page token
@@ -114,7 +125,8 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
      */
     listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>>;
     /**
-     *
+     * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the layout
      * @param {number} id
      * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
      * @param {string} [authorization] Bearer Token
@@ -129,32 +141,36 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
  */
 export declare const LayoutsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     *
+     * This will create a layout.
+     * @summary Create the layout
      * @param {CreateLayoutRequestDto} createLayoutRequestDto
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
+    createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass>;
     /**
-     *
+     * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+     * @summary Delete the layout
      * @param {number} id
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<object>;
+    deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
     /**
-     *
+     * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+     * @summary Retrieve the layout
      * @param {string} id
-     * @param {number} id2 Layout id
+     * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getLayout(id: string, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass>;
     /**
-     *
+     * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List layouts
      * @param {string} [authorization] Bearer Token
      * @param {number} [pageSize] Page size
      * @param {string} [pageToken] Page token
@@ -167,7 +183,8 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
      */
     listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListLayoutsResponseClass>;
     /**
-     *
+     * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the layout
      * @param {number} id
      * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
      * @param {string} [authorization] Bearer Token
@@ -227,7 +244,7 @@ export interface LayoutsApiGetLayoutRequest {
      */
     readonly id: string;
     /**
-     * Layout id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof LayoutsApiGetLayout
      */
@@ -321,23 +338,26 @@ export interface LayoutsApiUpdateLayoutRequest {
  */
 export declare class LayoutsApi extends BaseAPI {
     /**
-     *
+     * This will create a layout.
+     * @summary Create the layout
      * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof LayoutsApi
      */
-    createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any>>;
     /**
-     *
+     * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+     * @summary Delete the layout
      * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof LayoutsApi
      */
-    deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
     /**
-     *
+     * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+     * @summary Retrieve the layout
      * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -345,7 +365,8 @@ export declare class LayoutsApi extends BaseAPI {
      */
     getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any>>;
     /**
-     *
+     * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List layouts
      * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -353,7 +374,8 @@ export declare class LayoutsApi extends BaseAPI {
      */
     listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any>>;
     /**
-     *
+     * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the layout
      * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}