@emilgroup/document-sdk-node 1.2.0 → 1.2.1

package/dist/api/searchable-document-owners-api.js

@@ -97,7 +97,8 @@ var SearchableDocumentOwnersApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         *
+         * Returns the list of the searchable document owners.
+         * @summary List searchable document owners
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
@@ -108,7 +109,7 @@ var SearchableDocumentOwnersApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listSearchableDocuments: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
+        listSearchableDocumentOwners: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -174,7 +175,8 @@ var SearchableDocumentOwnersApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.SearchableDocumentOwnersApiAxiosParamCreator)(configuration);
     return {
         /**
-         *
+         * Returns the list of the searchable document owners.
+         * @summary List searchable document owners
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
@@ -185,12 +187,12 @@ var SearchableDocumentOwnersApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listSearchableDocuments: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
+        listSearchableDocumentOwners: function (authorization, pageSize, pageToken, filter, search, order, expand, 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.listSearchableDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -209,7 +211,8 @@ var SearchableDocumentOwnersApiFactory = function (configuration, basePath, axio
     var localVarFp = (0, exports.SearchableDocumentOwnersApiFp)(configuration);
     return {
         /**
-         *
+         * Returns the list of the searchable document owners.
+         * @summary List searchable document owners
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
@@ -220,8 +223,8 @@ var SearchableDocumentOwnersApiFactory = function (configuration, basePath, axio
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listSearchableDocuments: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
-            return localVarFp.listSearchableDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
+        listSearchableDocumentOwners: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
+            return localVarFp.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
         },
     };
 };
@@ -238,16 +241,17 @@ var SearchableDocumentOwnersApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
-     * @param {SearchableDocumentOwnersApiListSearchableDocumentsRequest} requestParameters Request parameters.
+     * Returns the list of the searchable document owners.
+     * @summary List searchable document owners
+     * @param {SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof SearchableDocumentOwnersApi
      */
-    SearchableDocumentOwnersApi.prototype.listSearchableDocuments = function (requestParameters, options) {
+    SearchableDocumentOwnersApi.prototype.listSearchableDocumentOwners = function (requestParameters, options) {
         var _this = this;
         if (requestParameters === void 0) { requestParameters = {}; }
-        return (0, exports.SearchableDocumentOwnersApiFp)(this.configuration).listSearchableDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.SearchableDocumentOwnersApiFp)(this.configuration).listSearchableDocumentOwners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     return SearchableDocumentOwnersApi;
 }(base_1.BaseAPI));

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/api.d.ts

@@ -12,5 +12,6 @@
 export * from './api/document-templates-api';
 export * from './api/documents-api';
 export * from './api/layouts-api';
+export * from './api/search-keywords-api';
 export * from './api/searchable-document-owners-api';
 export * from './api/searchable-documents-api';

package/dist/api.js

@@ -30,5 +30,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api/document-templates-api"), exports);
 __exportStar(require("./api/documents-api"), exports);
 __exportStar(require("./api/layouts-api"), exports);
+__exportStar(require("./api/search-keywords-api"), exports);
 __exportStar(require("./api/searchable-document-owners-api"), exports);
 __exportStar(require("./api/searchable-documents-api"), exports);

package/dist/base.js

@@ -109,7 +109,7 @@ var axios_1 = __importDefault(require("axios"));
 var fs = __importStar(require("fs"));
 var path = __importStar(require("path"));
 var os = __importStar(require("os"));
-exports.BASE_PATH = "https://apiv2.emil.de".replace(/\/+$/, "");
+exports.BASE_PATH = "http://localhost".replace(/\/+$/, "");
 var CONFIG_DIRECTORY = '.emil';
 var CONFIG_FILENAME = 'credentials';
 var KEY_USERNAME = 'emil_username';

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

@@ -17,27 +17,33 @@ import { CreateHtmlTemplateDto } from './create-html-template-dto';
  */
 export interface CreateDocTemplateRequestDto {
     /**
-     * Template name
+     * Template name.
      * @type {string}
      * @memberof CreateDocTemplateRequestDto
      */
     'name': string;
     /**
-     * Template 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
      */
     'slug': string;
     /**
-     *
+     * Unique identifier referencing the layout.
      * @type {number}
      * @memberof CreateDocTemplateRequestDto
      */
     'layoutId': number;
     /**
-     *
+     * Body template.
      * @type {CreateHtmlTemplateDto}
      * @memberof CreateDocTemplateRequestDto
      */
     'bodyTemplate': CreateHtmlTemplateDto;
+    /**
+     * 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;
 }

package/dist/models/create-doc-template-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 { DocTemplateClass } from './doc-template-class';
+/**
+ *
+ * @export
+ * @interface CreateDocTemplateResponseClass
+ */
+export interface CreateDocTemplateResponseClass {
+    /**
+     * Document template.
+     * @type {DocTemplateClass}
+     * @memberof CreateDocTemplateResponseClass
+     */
+    'template': DocTemplateClass;
+}

package/dist/models/create-doc-template-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-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,19 +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 referencing the entity on the service 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.
      * @type {number}
      * @memberof CreateDocumentRequestDto
      */
@@ -70,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
      */
@@ -80,13 +86,19 @@ 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}
      * @memberof CreateDocumentRequestDto
      */
     'filename'?: string;
+    /**
+     * 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;
 }
 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-html-template-dto.d.ts

@@ -16,7 +16,7 @@
  */
 export interface CreateHtmlTemplateDto {
     /**
-     * Template draft content
+     * Template draft content.
      * @type {string}
      * @memberof CreateHtmlTemplateDto
      */

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 });