@emilgroup/document-sdk-node 1.1.0 → 1.2.1

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

@@ -19,9 +19,10 @@ import { ListSearchableDocumentsResponseClass } from '../models';
  */
 export declare const SearchableDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *
-     * @param {string} searchText Text to search in the documents
-     * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided)
+     * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List searchable documents
+     * @param {string} searchText Text to search in the documents.
+     * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -34,9 +35,10 @@ export declare const SearchableDocumentsApiAxiosParamCreator: (configuration?: C
  */
 export declare const SearchableDocumentsApiFp: (configuration?: Configuration) => {
     /**
-     *
-     * @param {string} searchText Text to search in the documents
-     * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided)
+     * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List searchable documents
+     * @param {string} searchText Text to search in the documents.
+     * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -49,9 +51,10 @@ export declare const SearchableDocumentsApiFp: (configuration?: Configuration) =
  */
 export declare const SearchableDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     *
-     * @param {string} searchText Text to search in the documents
-     * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided)
+     * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List searchable documents
+     * @param {string} searchText Text to search in the documents.
+     * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -65,13 +68,13 @@ export declare const SearchableDocumentsApiFactory: (configuration?: Configurati
  */
 export interface SearchableDocumentsApiListSearchableDocumentsRequest {
     /**
-     * Text to search in the documents
+     * Text to search in the documents.
      * @type {string}
      * @memberof SearchableDocumentsApiListSearchableDocuments
      */
     readonly searchText: string;
     /**
-     * List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided)
+     * List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
      * @type {string}
      * @memberof SearchableDocumentsApiListSearchableDocuments
      */
@@ -91,7 +94,8 @@ export interface SearchableDocumentsApiListSearchableDocumentsRequest {
  */
 export declare class SearchableDocumentsApi extends BaseAPI {
     /**
-     *
+     * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List searchable documents
      * @param {SearchableDocumentsApiListSearchableDocumentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/api/searchable-documents-api.js

@@ -97,9 +97,10 @@ var SearchableDocumentsApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         *
-         * @param {string} searchText Text to search in the documents
-         * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided)
+         * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List searchable documents
+         * @param {string} searchText Text to search in the documents.
+         * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -162,9 +163,10 @@ var SearchableDocumentsApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.SearchableDocumentsApiAxiosParamCreator)(configuration);
     return {
         /**
-         *
-         * @param {string} searchText Text to search in the documents
-         * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided)
+         * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List searchable documents
+         * @param {string} searchText Text to search in the documents.
+         * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -193,9 +195,10 @@ var SearchableDocumentsApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.SearchableDocumentsApiFp)(configuration);
     return {
         /**
-         *
-         * @param {string} searchText Text to search in the documents
-         * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided)
+         * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List searchable documents
+         * @param {string} searchText Text to search in the documents.
+         * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -218,7 +221,8 @@ var SearchableDocumentsApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
+     * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List searchable documents
      * @param {SearchableDocumentsApiListSearchableDocumentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/base.d.ts

@@ -59,7 +59,7 @@ export declare class BaseAPI {
     private readEnvVariables;
     selectEnvironment(env: Environment): void;
     authorize(username: string, password: string): Promise<void>;
-    refreshToken(): Promise<string>;
+    refreshTokenInternal(): Promise<string>;
     private extractRefreshToken;
     getConfiguration(): Configuration;
     private attachInterceptor;

package/dist/base.js

@@ -270,7 +270,7 @@ var BaseAPI = /** @class */ (function () {
             });
         });
     };
-    BaseAPI.prototype.refreshToken = function () {
+    BaseAPI.prototype.refreshTokenInternal = function () {
         return __awaiter(this, void 0, void 0, function () {
             var _a, username, refreshToken, options, accessToken;
             return __generator(this, function (_b) {
@@ -324,7 +324,7 @@ var BaseAPI = /** @class */ (function () {
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, this.refreshToken()];
+                        return [4 /*yield*/, this.refreshTokenInternal()];
                     case 2:
                         tokenString = _a.sent();
                         accessToken = "Bearer ".concat(tokenString);
@@ -351,7 +351,7 @@ var BaseAPI = /** @class */ (function () {
                         _a.label = 6;
                     case 6:
                         _a.trys.push([6, 8, , 9]);
-                        return [4 /*yield*/, this.refreshToken()];
+                        return [4 /*yield*/, this.refreshTokenInternal()];
                     case 7:
                         tokenString = _a.sent();
                         accessToken = "Bearer ".concat(tokenString);

package/dist/models/create-doc-template-request-dto.d.ts

@@ -35,15 +35,15 @@ export interface CreateDocTemplateRequestDto {
      */
     'layoutId': number;
     /**
-     *
+     * Body template.
      * @type {CreateHtmlTemplateDto}
      * @memberof CreateDocTemplateRequestDto
      */
     'bodyTemplate': CreateHtmlTemplateDto;
     /**
-     * Product slug
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof CreateDocTemplateRequestDto
      */
-    'productSlug'?: string | null;
+    'productSlug'?: string;
 }

package/dist/models/create-doc-template-response-class.d.ts

@@ -17,7 +17,7 @@ import { DocTemplateClass } from './doc-template-class';
  */
 export interface CreateDocTemplateResponseClass {
     /**
-     *
+     * Document template.
      * @type {DocTemplateClass}
      * @memberof CreateDocTemplateResponseClass
      */

package/dist/models/create-document-request-dto.d.ts

@@ -16,7 +16,7 @@
  */
 export interface CreateDocumentRequestDto {
     /**
-     * A slug is a human-readable, unique identifier, used to identify a resource        instead of a less human-readable identifier like an id. In this case, the template used for this document.
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
@@ -28,13 +28,13 @@ export interface CreateDocumentRequestDto {
      */
     'payload': object;
     /**
-     * Document entity type
+     * Document entity type.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
     'entityType': CreateDocumentRequestDtoEntityTypeEnum;
     /**
-     * Description of the document. Usually a short summary about the      context in which the document is being used.
+     * Specifies the document creation strategy to be used, either synchronous or asynchronous.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
@@ -46,25 +46,25 @@ export interface CreateDocumentRequestDto {
      */
     'description': string;
     /**
-     * Unique identifier of the policy that the document belongs to
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
     'policyCode'?: string;
     /**
-     * Unique identifier of the account that the document belongs to
+     * Unique identifier of the account that this object belongs to.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
     'accountCode'?: string;
     /**
-     * Unique identifier of the lead that the document belongs to
+     * Unique identifier of the lead that this object belongs to.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
     'leadCode'?: string;
     /**
-     * Unique identifier referencing the entity on the service the document belongs to.
+     * Unique identifier referencing the entity.
      * @type {number}
      * @memberof CreateDocumentRequestDto
      */
@@ -76,7 +76,7 @@ export interface CreateDocumentRequestDto {
      */
     'requester': CreateDocumentRequestDtoRequesterEnum;
     /**
-     * Metadata can contain extra information that the document would need for specific cases.
+     * Metadata contains extra information that the object would need for specific cases.
      * @type {object}
      * @memberof CreateDocumentRequestDto
      */
@@ -86,7 +86,7 @@ export interface CreateDocumentRequestDto {
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
-    'contentType'?: CreateDocumentRequestDtoContentTypeEnum;
+    'contentType': CreateDocumentRequestDtoContentTypeEnum;
     /**
      * Name of the file the end user will see when he downloads it.
      * @type {string}
@@ -94,11 +94,11 @@ export interface CreateDocumentRequestDto {
      */
     'filename'?: string;
     /**
-     * The product slug that this file belong to.
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof CreateDocumentRequestDto
      */
-    'productSlug'?: string | null;
+    'productSlug'?: string;
 }
 export declare const CreateDocumentRequestDtoEntityTypeEnum: {
     readonly PolicyApplication: "policy_application";

package/dist/models/create-document-sync-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DocumentClass } from './document-class';
+/**
+ *
+ * @export
+ * @interface CreateDocumentSyncResponseClass
+ */
+export interface CreateDocumentSyncResponseClass {
+    /**
+     * Document
+     * @type {DocumentClass}
+     * @memberof CreateDocumentSyncResponseClass
+     */
+    'document': DocumentClass;
+}

package/dist/models/create-document-sync-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-layout-request-dto.d.ts

@@ -17,33 +17,33 @@ import { CreateHtmlTemplateDto } from './create-html-template-dto';
  */
 export interface CreateLayoutRequestDto {
     /**
-     * Layout name
+     * Layout name.
      * @type {string}
      * @memberof CreateLayoutRequestDto
      */
     'name': string;
     /**
-     * Layout slug
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof CreateLayoutRequestDto
      */
     'slug': string;
     /**
-     * Layout style
-     * @type {string}
-     * @memberof CreateLayoutRequestDto
-     */
-    'style': string;
-    /**
-     *
+     * Header template.
      * @type {CreateHtmlTemplateDto}
      * @memberof CreateLayoutRequestDto
      */
     'headerTemplate': CreateHtmlTemplateDto;
     /**
-     *
+     * Footer template.
      * @type {CreateHtmlTemplateDto}
      * @memberof CreateLayoutRequestDto
      */
     'footerTemplate': CreateHtmlTemplateDto;
+    /**
+     * Layout style.
+     * @type {string}
+     * @memberof CreateLayoutRequestDto
+     */
+    'style': string;
 }

package/dist/models/create-layout-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { LayoutClass } from './layout-class';
+/**
+ *
+ * @export
+ * @interface CreateLayoutResponseClass
+ */
+export interface CreateLayoutResponseClass {
+    /**
+     * Layout
+     * @type {LayoutClass}
+     * @memberof CreateLayoutResponseClass
+     */
+    'layout': LayoutClass;
+}

package/dist/models/create-layout-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-presigned-post-request-dto.d.ts

@@ -16,19 +16,19 @@
  */
 export interface CreatePresignedPostRequestDto {
     /**
-     * A slug is a human-readable, unique identifier, used to identify a resource        instead of a less human-readable identifier like an id. In this case, the template used for this document.
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'templateSlug': string;
     /**
-     * Document entity type
+     * Document entity type.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'entityType': string;
     /**
-     * Identifier of the entity that the document is related to
+     * Unique identifier referencing the entity.
      * @type {number}
      * @memberof CreatePresignedPostRequestDto
      */
@@ -40,19 +40,19 @@ export interface CreatePresignedPostRequestDto {
      */
     'description': string;
     /**
-     * Unique identifier of the policy that the document belongs to
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'policyCode'?: string;
     /**
-     * Unique identifier of the account that the document belongs to
+     * Unique identifier of the account that this object belongs to.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'accountCode'?: string;
     /**
-     * Unique identifier of the lead that the document belongs to
+     * Unique identifier of the lead that this object belongs to.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
@@ -64,13 +64,13 @@ export interface CreatePresignedPostRequestDto {
      */
     'requester': CreatePresignedPostRequestDtoRequesterEnum;
     /**
-     * Extension of the file
+     * Extension of the file.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
     'contentType': CreatePresignedPostRequestDtoContentTypeEnum;
     /**
-     * Content type of the file
+     * Content type of the file.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
@@ -82,11 +82,11 @@ export interface CreatePresignedPostRequestDto {
      */
     'filename': string;
     /**
-     * The product slug that this file belong to.
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof CreatePresignedPostRequestDto
      */
-    'productSlug'?: string | null;
+    'productSlug'?: string;
 }
 export declare const CreatePresignedPostRequestDtoRequesterEnum: {
     readonly Accountservice: "accountservice";

package/dist/models/create-presigned-post-response-class.d.ts

@@ -16,13 +16,13 @@
  */
 export interface CreatePresignedPostResponseClass {
     /**
-     * Upload document fields
+     * Upload document fields.
      * @type {object}
      * @memberof CreatePresignedPostResponseClass
      */
     'fields': object;
     /**
-     * Pre-signed Url
+     * Pre-signed Url.
      * @type {string}
      * @memberof CreatePresignedPostResponseClass
      */

package/dist/models/delete-layout-request-dto.d.ts

@@ -16,7 +16,7 @@
  */
 export interface DeleteLayoutRequestDto {
     /**
-     * Layout id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof DeleteLayoutRequestDto
      */

package/dist/models/delete-request-dto.d.ts

@@ -16,7 +16,7 @@
  */
 export interface DeleteRequestDto {
     /**
-     * Resource id
+     * Unique identifier for the object.
      * @type {string}
      * @memberof DeleteRequestDto
      */

package/dist/models/delete-response-class.d.ts

@@ -0,0 +1,24 @@
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface DeleteResponseClass
+ */
+export interface DeleteResponseClass {
+    /**
+     *
+     * @type {object}
+     * @memberof DeleteResponseClass
+     */
+    'response': object;
+}

package/dist/models/delete-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/doc-template-class.d.ts

@@ -60,7 +60,7 @@ export interface DocTemplateClass {
      */
     'layout'?: LayoutClass;
     /**
-     * Product slug.
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof DocTemplateClass
      */
@@ -78,7 +78,7 @@ export interface DocTemplateClass {
      */
     'updatedAt': string;
     /**
-     * Template updated at
+     * Time at which the object was deleted.
      * @type {string}
      * @memberof DocTemplateClass
      */

package/dist/models/document-class.d.ts

@@ -28,13 +28,13 @@ export interface DocumentClass {
      */
     'code': string;
     /**
-     * A slug is a human-readable, unique identifier, used to identify a resource        instead of a less human-readable identifier like an id. In this case, the template used for this document.
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof DocumentClass
      */
     'templateSlug': string;
     /**
-     * Document entity type
+     * Document entity type.
      * @type {string}
      * @memberof DocumentClass
      */
@@ -46,25 +46,25 @@ export interface DocumentClass {
      */
     'payload'?: object;
     /**
-     * Unique identifier of the policy that the document belongs to
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof DocumentClass
      */
     'policyCode'?: string;
     /**
-     * Unique identifier of the account that the document belongs to
+     * Unique identifier of the account that this object belongs to.
      * @type {string}
      * @memberof DocumentClass
      */
     'accountCode'?: string;
     /**
-     * Unique identifier of the lead that the document belongs to
+     * Unique identifier of the lead that this object belongs to.
      * @type {string}
      * @memberof DocumentClass
      */
     'leadCode'?: string;
     /**
-     * Unique identifier referencing the entity on the service the document belongs to.
+     * Unique identifier referencing the entity.
      * @type {number}
      * @memberof DocumentClass
      */
@@ -76,7 +76,7 @@ export interface DocumentClass {
      */
     'requester': DocumentClassRequesterEnum;
     /**
-     * Metadata can contain extra information that the document would need for specific cases.
+     * Metadata contains extra information that the object would need for specific cases.
      * @type {object}
      * @memberof DocumentClass
      */
@@ -100,7 +100,7 @@ export interface DocumentClass {
      */
     'contentType': DocumentClassContentTypeEnum;
     /**
-     * Product that this document belong to
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof DocumentClass
      */

package/dist/models/download-document-request-dto.d.ts

@@ -16,13 +16,13 @@
  */
 export interface DownloadDocumentRequestDto {
     /**
-     * Document code
+     *
      * @type {string}
      * @memberof DownloadDocumentRequestDto
      */
     'code': string;
     /**
-     * Document key
+     *
      * @type {string}
      * @memberof DownloadDocumentRequestDto
      */