@emilgroup/document-sdk-node 1.2.0 → 1.3.0

package/api/documents-api.ts

@@ -23,11 +23,21 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 // @ts-ignore
 import { CreateDocumentRequestDto } from '../models';
 // @ts-ignore
+import { CreateDocumentSyncResponseClass } from '../models';
+// @ts-ignore
+import { CreatePresignedPostRequestDto } from '../models';
+// @ts-ignore
+import { CreatePresignedPostResponseClass } from '../models';
+// @ts-ignore
 import { GetDocumentDownloadUrlResponseClass } from '../models';
 // @ts-ignore
+import { GetSignedS3KeyUrlResponseClass } from '../models';
+// @ts-ignore
 import { ListDocumentsResponseClass } from '../models';
 // @ts-ignore
 import { UpdateDocumentRequestDto } from '../models';
+// @ts-ignore
+import { UpdateDocumentResponseClass } from '../models';
 // URLSearchParams not necessarily used
 // @ts-ignore
 import { URL, URLSearchParams } from 'url';
@@ -39,7 +49,7 @@ const FormData = require('form-data');
 export const DocumentsApiAxiosParamCreator = function (configuration?: 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).
          * @summary Create the document
          * @param {CreateDocumentRequestDto} createDocumentRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -86,16 +96,17 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
             };
         },
         /**
-         * 
-         * @param {CreateDocumentRequestDto} createDocumentRequestDto 
+         * 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
+         * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createTemporaryDocument: async (createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'createDocumentRequestDto' is not null or undefined
-            assertParamExists('createTemporaryDocument', 'createDocumentRequestDto', createDocumentRequestDto)
-            const localVarPath = `/documentservice/v1/documents/temporary`;
+        createPresignedPost: async (createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createPresignedPostRequestDto' is not null or undefined
+            assertParamExists('createPresignedPost', 'createPresignedPostRequestDto', createPresignedPostRequestDto)
+            const localVarPath = `/documentservice/v1/documents/pre-signed-post`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -124,7 +135,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(createDocumentRequestDto, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(createPresignedPostRequestDto, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -212,6 +223,54 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (s3Key: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 's3Key' is not null or undefined
+            assertParamExists('getSignedS3keyUrl', 's3Key', s3Key)
+            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);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (s3Key !== undefined) {
+                localVarQueryParameter['s3Key'] = s3Key;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -354,26 +413,27 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = 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).
          * @summary Create the document
          * @param {CreateDocumentRequestDto} createDocumentRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocumentSyncResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.createDocument(createDocumentRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
-         * @param {CreateDocumentRequestDto} createDocumentRequestDto 
+         * 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
+         * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.createTemporaryDocument(createDocumentRequestDto, authorization, options);
+        async createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createPresignedPost(createPresignedPostRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -400,6 +460,18 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * This will return a presigned URL for a random S3 key
+         * @summary Fetches a presigned URL for a S3 key
+         * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+         * @param {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<GetSignedS3KeyUrlResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, 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
@@ -426,7 +498,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocumentResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocument(code, updateDocumentRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -441,25 +513,26 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
     const localVarFp = 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).
          * @summary Create the document
          * @param {CreateDocumentRequestDto} createDocumentRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
+        createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocumentSyncResponseClass> {
             return localVarFp.createDocument(createDocumentRequestDto, authorization, options).then((request) => 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 5 minutes to 7 days.
+         * @summary Upload documents using pre-signed URL
+         * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
-            return localVarFp.createTemporaryDocument(createDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
+        createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass> {
+            return localVarFp.createPresignedPost(createPresignedPostRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
          * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
@@ -483,6 +556,17 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
         getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass> {
             return localVarFp.getDocumentDownloadUrl(code, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * This will return a presigned URL for a random S3 key
+         * @summary Fetches a presigned URL for a S3 key
+         * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass> {
+            return localVarFp.getSignedS3keyUrl(s3Key, 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.
          * @summary List documents
@@ -508,7 +592,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
+        updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocumentResponseClass> {
             return localVarFp.updateDocument(code, updateDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
     };
@@ -536,22 +620,22 @@ export interface DocumentsApiCreateDocumentRequest {
 }
 
 /**
- * Request parameters for createTemporaryDocument operation in DocumentsApi.
+ * Request parameters for createPresignedPost operation in DocumentsApi.
  * @export
- * @interface DocumentsApiCreateTemporaryDocumentRequest
+ * @interface DocumentsApiCreatePresignedPostRequest
  */
-export interface DocumentsApiCreateTemporaryDocumentRequest {
+export interface DocumentsApiCreatePresignedPostRequest {
     /**
      * 
-     * @type {CreateDocumentRequestDto}
-     * @memberof DocumentsApiCreateTemporaryDocument
+     * @type {CreatePresignedPostRequestDto}
+     * @memberof DocumentsApiCreatePresignedPost
      */
-    readonly createDocumentRequestDto: CreateDocumentRequestDto
+    readonly createPresignedPostRequestDto: CreatePresignedPostRequestDto
 
     /**
      * Bearer Token
      * @type {string}
-     * @memberof DocumentsApiCreateTemporaryDocument
+     * @memberof DocumentsApiCreatePresignedPost
      */
     readonly authorization?: string
 }
@@ -598,6 +682,27 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for getSignedS3keyUrl operation in DocumentsApi.
+ * @export
+ * @interface DocumentsApiGetSignedS3keyUrlRequest
+ */
+export interface DocumentsApiGetSignedS3keyUrlRequest {
+    /**
+     * Key for the file in S3 bucket to create the presigned download URL for
+     * @type {string}
+     * @memberof DocumentsApiGetSignedS3keyUrl
+     */
+    readonly s3Key: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DocumentsApiGetSignedS3keyUrl
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for listDocuments operation in DocumentsApi.
  * @export
@@ -690,7 +795,7 @@ export interface DocumentsApiUpdateDocumentRequest {
  */
 export class DocumentsApi extends BaseAPI {
     /**
-     * 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).
      * @summary Create the document
      * @param {DocumentsApiCreateDocumentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -702,14 +807,15 @@ export class DocumentsApi extends BaseAPI {
     }
 
     /**
-     * 
-     * @param {DocumentsApiCreateTemporaryDocumentRequest} requestParameters Request parameters.
+     * 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
+     * @param {DocumentsApiCreatePresignedPostRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentsApi
      */
-    public createTemporaryDocument(requestParameters: DocumentsApiCreateTemporaryDocumentRequest, options?: AxiosRequestConfig) {
-        return DocumentsApiFp(this.configuration).createTemporaryDocument(requestParameters.createDocumentRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    public createPresignedPost(requestParameters: DocumentsApiCreatePresignedPostRequest, options?: AxiosRequestConfig) {
+        return DocumentsApiFp(this.configuration).createPresignedPost(requestParameters.createPresignedPostRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -736,6 +842,18 @@ export class DocumentsApi extends BaseAPI {
         return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, options).then((request) => 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
+     */
+    public getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig) {
+        return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then((request) => 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/api/layouts-api.ts

@@ -23,6 +23,10 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 // @ts-ignore
 import { CreateLayoutRequestDto } from '../models';
 // @ts-ignore
+import { CreateLayoutResponseClass } from '../models';
+// @ts-ignore
+import { DeleteResponseClass } from '../models';
+// @ts-ignore
 import { GetLayoutResponseClass } from '../models';
 // @ts-ignore
 import { ListLayoutsResponseClass } from '../models';
@@ -41,7 +45,8 @@ const FormData = require('form-data');
 export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * This will create a layout.
+         * @summary Create the layout
          * @param {CreateLayoutRequestDto} createLayoutRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -87,7 +92,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * 
+         * 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.
@@ -131,9 +137,10 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * 
+         * 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}
@@ -182,7 +189,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * 
+         * 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
@@ -252,7 +260,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * 
+         * 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
@@ -312,31 +321,34 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * 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}
          */
-        async createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.createLayout(createLayoutRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * 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}
          */
-        async deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLayout(id, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * 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}
@@ -346,7 +358,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * 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
@@ -362,7 +375,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * 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
@@ -384,29 +398,32 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
     const localVarFp = LayoutsApiFp(configuration)
     return {
         /**
-         * 
+         * 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> {
             return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * 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> {
             return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * 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}
@@ -415,7 +432,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
             return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * 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
@@ -430,7 +448,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
             return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * 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
@@ -499,7 +518,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
      */
@@ -605,7 +624,8 @@ export interface LayoutsApiUpdateLayoutRequest {
  */
 export 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}
@@ -616,7 +636,8 @@ export class LayoutsApi extends BaseAPI {
     }
 
     /**
-     * 
+     * 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}
@@ -627,7 +648,8 @@ export class LayoutsApi extends BaseAPI {
     }
 
     /**
-     * 
+     * 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}
@@ -638,7 +660,8 @@ export class LayoutsApi extends BaseAPI {
     }
 
     /**
-     * 
+     * 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}
@@ -649,7 +672,8 @@ export class LayoutsApi extends BaseAPI {
     }
 
     /**
-     * 
+     * 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}