@emilgroup/document-sdk-node 1.0.0

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

@@ -0,0 +1,232 @@
+/* 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 { ListSearchableDocumentOwnersResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * SearchableDocumentOwnersApi - axios parameter creator
+ * @export
+ */
+export const SearchableDocumentOwnersApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @param {string} [authorization] Bearer Token
+         * @param {number} [pageSize] Page size
+         * @param {string} [pageToken] Page token
+         * @param {string} [filter] List filter
+         * @param {string} [search] Search query
+         * @param {string} [order] Ordering criteria
+         * @param {string} [expand] Extra fields to fetch
+         * @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> => {
+            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);
+            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 (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (filter !== undefined) {
+                localVarQueryParameter['filter'] = filter;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            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,
+            };
+        },
+    }
+};
+
+/**
+ * SearchableDocumentOwnersApi - functional programming interface
+ * @export
+ */
+export const SearchableDocumentOwnersApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SearchableDocumentOwnersApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @param {string} [authorization] Bearer Token
+         * @param {number} [pageSize] Page size
+         * @param {string} [pageToken] Page token
+         * @param {string} [filter] List filter
+         * @param {string} [search] Search query
+         * @param {string} [order] Ordering criteria
+         * @param {string} [expand] Extra fields to fetch
+         * @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);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * SearchableDocumentOwnersApi - factory interface
+ * @export
+ */
+export const SearchableDocumentOwnersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SearchableDocumentOwnersApiFp(configuration)
+    return {
+        /**
+         * 
+         * @param {string} [authorization] Bearer Token
+         * @param {number} [pageSize] Page size
+         * @param {string} [pageToken] Page token
+         * @param {string} [filter] List filter
+         * @param {string} [search] Search query
+         * @param {string} [order] Ordering criteria
+         * @param {string} [expand] Extra fields to fetch
+         * @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));
+        },
+    };
+};
+
+/**
+ * Request parameters for listSearchableDocuments operation in SearchableDocumentOwnersApi.
+ * @export
+ * @interface SearchableDocumentOwnersApiListSearchableDocumentsRequest
+ */
+export interface SearchableDocumentOwnersApiListSearchableDocumentsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     */
+    readonly authorization?: string
+
+    /**
+     * Page size
+     * @type {number}
+     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     */
+    readonly pageSize?: number
+
+    /**
+     * Page token
+     * @type {string}
+     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     */
+    readonly pageToken?: string
+
+    /**
+     * List filter
+     * @type {string}
+     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     */
+    readonly filter?: string
+
+    /**
+     * Search query
+     * @type {string}
+     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     */
+    readonly search?: string
+
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     */
+    readonly order?: string
+
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof SearchableDocumentOwnersApiListSearchableDocuments
+     */
+    readonly expand?: string
+}
+
+/**
+ * SearchableDocumentOwnersApi - object-oriented interface
+ * @export
+ * @class SearchableDocumentOwnersApi
+ * @extends {BaseAPI}
+ */
+export class SearchableDocumentOwnersApi extends BaseAPI {
+    /**
+     * 
+     * @param {SearchableDocumentOwnersApiListSearchableDocumentsRequest} 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));
+    }
+}

package/api/searchable-documents-api.ts

@@ -0,0 +1,180 @@
+/* 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 { ListSearchableDocumentsResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * SearchableDocumentsApi - axios parameter creator
+ * @export
+ */
+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)
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSearchableDocuments: async (searchText: string, ownerIds: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'searchText' is not null or undefined
+            assertParamExists('listSearchableDocuments', 'searchText', searchText)
+            // verify required parameter 'ownerIds' is not null or undefined
+            assertParamExists('listSearchableDocuments', 'ownerIds', ownerIds)
+            const localVarPath = `/documentservice/v1/searchable-documents`;
+            // 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 (ownerIds !== undefined) {
+                localVarQueryParameter['ownerIds'] = ownerIds;
+            }
+
+            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,
+            };
+        },
+    }
+};
+
+/**
+ * SearchableDocumentsApi - functional programming interface
+ * @export
+ */
+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 \&#39;*\&#39; list provided)
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listSearchableDocuments(searchText: string, ownerIds: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchableDocuments(searchText, ownerIds, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * SearchableDocumentsApi - factory interface
+ * @export
+ */
+export const SearchableDocumentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    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 \&#39;*\&#39; list provided)
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSearchableDocuments(searchText: string, ownerIds: string, authorization?: string, options?: any): AxiosPromise<ListSearchableDocumentsResponseClass> {
+            return localVarFp.listSearchableDocuments(searchText, ownerIds, authorization, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for listSearchableDocuments operation in SearchableDocumentsApi.
+ * @export
+ * @interface SearchableDocumentsApiListSearchableDocumentsRequest
+ */
+export interface SearchableDocumentsApiListSearchableDocumentsRequest {
+    /**
+     * 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 \&#39;*\&#39; list provided)
+     * @type {string}
+     * @memberof SearchableDocumentsApiListSearchableDocuments
+     */
+    readonly ownerIds: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof SearchableDocumentsApiListSearchableDocuments
+     */
+    readonly authorization?: string
+}
+
+/**
+ * SearchableDocumentsApi - object-oriented interface
+ * @export
+ * @class SearchableDocumentsApi
+ * @extends {BaseAPI}
+ */
+export class SearchableDocumentsApi extends BaseAPI {
+    /**
+     * 
+     * @param {SearchableDocumentsApiListSearchableDocumentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchableDocumentsApi
+     */
+    public listSearchableDocuments(requestParameters: SearchableDocumentsApiListSearchableDocumentsRequest, options?: AxiosRequestConfig) {
+        return SearchableDocumentsApiFp(this.configuration).listSearchableDocuments(requestParameters.searchText, requestParameters.ownerIds, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/api.ts

@@ -0,0 +1,44 @@
+/* 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 { Configuration } from './configuration';
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+import FormData from 'form-data'
+// 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';
+import { DocumentTemplatesApi } from './api';
+import { DocumentsApi } from './api';
+import { LayoutsApi } from './api';
+import { SearchableDocumentOwnersApi } from './api';
+import { SearchableDocumentsApi } from './api';
+
+
+export * from './api/document-templates-api';
+export * from './api/documents-api';
+export * from './api/layouts-api';
+export * from './api/searchable-document-owners-api';
+export * from './api/searchable-documents-api';
+
+
+export enum Environment {
+    Production = 'https://apiv2.emil.de',
+    Test = 'https://apiv2-test.emil.de',
+}