@emilgroup/document-sdk-node 1.2.0 → 1.2.1

package/api/search-keywords-api.ts

@@ -0,0 +1,168 @@
+/* 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.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { ListSearchKeywordsResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * SearchKeywordsApi - axios parameter creator
+ * @export
+ */
+export const SearchKeywordsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
+         * @summary List keywords
+         * @param {string} searchText Text to search in the documents.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSearchKeywords: async (searchText: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'searchText' is not null or undefined
+            assertParamExists('listSearchKeywords', 'searchText', searchText)
+            const localVarPath = `/documentservice/v1/search-keywords`;
+            // 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 (searchText !== undefined) {
+                localVarQueryParameter['searchText'] = searchText;
+            }
+
+            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};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * SearchKeywordsApi - functional programming interface
+ * @export
+ */
+export const SearchKeywordsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SearchKeywordsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
+         * @summary List keywords
+         * @param {string} searchText Text to search in the documents.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listSearchKeywords(searchText: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchKeywordsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchKeywords(searchText, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * SearchKeywordsApi - factory interface
+ * @export
+ */
+export const SearchKeywordsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SearchKeywordsApiFp(configuration)
+    return {
+        /**
+         * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
+         * @summary List keywords
+         * @param {string} searchText Text to search in the documents.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSearchKeywords(searchText: string, authorization?: string, options?: any): AxiosPromise<ListSearchKeywordsResponseClass> {
+            return localVarFp.listSearchKeywords(searchText, authorization, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for listSearchKeywords operation in SearchKeywordsApi.
+ * @export
+ * @interface SearchKeywordsApiListSearchKeywordsRequest
+ */
+export interface SearchKeywordsApiListSearchKeywordsRequest {
+    /**
+     * Text to search in the documents.
+     * @type {string}
+     * @memberof SearchKeywordsApiListSearchKeywords
+     */
+    readonly searchText: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SearchKeywordsApiListSearchKeywords
+     */
+    readonly authorization?: string
+}
+
+/**
+ * SearchKeywordsApi - object-oriented interface
+ * @export
+ * @class SearchKeywordsApi
+ * @extends {BaseAPI}
+ */
+export class SearchKeywordsApi extends BaseAPI {
+    /**
+     * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
+     * @summary List keywords
+     * @param {SearchKeywordsApiListSearchKeywordsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchKeywordsApi
+     */
+    public listSearchKeywords(requestParameters: SearchKeywordsApiListSearchKeywordsRequest, options?: AxiosRequestConfig) {
+        return SearchKeywordsApiFp(this.configuration).listSearchKeywords(requestParameters.searchText, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/api/searchable-document-owners-api.ts

@@ -33,7 +33,8 @@ const FormData = require('form-data');
 export const SearchableDocumentOwnersApiAxiosParamCreator = function (configuration?: 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
@@ -44,7 +45,7 @@ export const SearchableDocumentOwnersApiAxiosParamCreator = function (configurat
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listSearchableDocuments: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listSearchableDocumentOwners: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/documentservice/v1/searchable-document-owners`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -113,7 +114,8 @@ export const SearchableDocumentOwnersApiFp = function(configuration?: Configurat
     const localVarAxiosParamCreator = 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
@@ -124,8 +126,8 @@ export const SearchableDocumentOwnersApiFp = function(configuration?: Configurat
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listSearchableDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentOwnersResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchableDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options);
+        async listSearchableDocumentOwners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentOwnersResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     }
@@ -139,7 +141,8 @@ export const SearchableDocumentOwnersApiFactory = function (configuration?: Conf
     const localVarFp = 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
@@ -150,64 +153,64 @@ export const SearchableDocumentOwnersApiFactory = function (configuration?: Conf
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listSearchableDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListSearchableDocumentOwnersResponseClass> {
-            return localVarFp.listSearchableDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
+        listSearchableDocumentOwners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListSearchableDocumentOwnersResponseClass> {
+            return localVarFp.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
         },
     };
 };
 
 /**
- * Request parameters for listSearchableDocuments operation in SearchableDocumentOwnersApi.
+ * Request parameters for listSearchableDocumentOwners operation in SearchableDocumentOwnersApi.
  * @export
- * @interface SearchableDocumentOwnersApiListSearchableDocumentsRequest
+ * @interface SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest
  */
-export interface SearchableDocumentOwnersApiListSearchableDocumentsRequest {
+export interface SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest {
     /**
      * Bearer Token
      * @type {string}
-     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
      */
     readonly authorization?: string
 
     /**
      * Page size
      * @type {number}
-     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
      */
     readonly pageSize?: number
 
     /**
      * Page token
      * @type {string}
-     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
      */
     readonly pageToken?: string
 
     /**
      * List filter
      * @type {string}
-     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
      */
     readonly filter?: string
 
     /**
      * Search query
      * @type {string}
-     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
      */
     readonly search?: string
 
     /**
      * Ordering criteria
      * @type {string}
-     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
      */
     readonly order?: string
 
     /**
      * Extra fields to fetch
      * @type {string}
-     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
      */
     readonly expand?: string
 }
@@ -220,13 +223,14 @@ export interface SearchableDocumentOwnersApiListSearchableDocumentsRequest {
  */
 export class SearchableDocumentOwnersApi extends BaseAPI {
     /**
-     * 
-     * @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
      */
-    public listSearchableDocuments(requestParameters: SearchableDocumentOwnersApiListSearchableDocumentsRequest = {}, options?: AxiosRequestConfig) {
-        return SearchableDocumentOwnersApiFp(this.configuration).listSearchableDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    public listSearchableDocumentOwners(requestParameters: SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest = {}, options?: AxiosRequestConfig) {
+        return SearchableDocumentOwnersApiFp(this.configuration).listSearchableDocumentOwners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
     }
 }

package/api/searchable-documents-api.ts

@@ -33,9 +33,10 @@ const FormData = require('form-data');
 export const SearchableDocumentsApiAxiosParamCreator = function (configuration?: 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}
@@ -97,9 +98,10 @@ export const SearchableDocumentsApiFp = function(configuration?: Configuration)
     const localVarAxiosParamCreator = 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}
@@ -119,9 +121,10 @@ export const SearchableDocumentsApiFactory = function (configuration?: Configura
     const localVarFp = 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}
@@ -139,14 +142,14 @@ export const SearchableDocumentsApiFactory = function (configuration?: Configura
  */
 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
      */
@@ -168,7 +171,8 @@ export interface SearchableDocumentsApiListSearchableDocumentsRequest {
  */
 export 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/api.ts

@@ -27,6 +27,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 import { DocumentTemplatesApi } from './api';
 import { DocumentsApi } from './api';
 import { LayoutsApi } from './api';
+import { SearchKeywordsApi } from './api';
 import { SearchableDocumentOwnersApi } from './api';
 import { SearchableDocumentsApi } from './api';
 
@@ -34,6 +35,7 @@ import { SearchableDocumentsApi } from './api';
 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/base.ts

@@ -21,7 +21,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as os from 'os';
 
-export const BASE_PATH = "https://apiv2.emil.de".replace(/\/+$/, "");
+export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
 const CONFIG_DIRECTORY = '.emil';
 const CONFIG_FILENAME = 'credentials';
 const KEY_USERNAME = 'emil_username';