@openfilz-sdk/typescript-ee 1.4.4 → 1.5.1

package/api/digital-signature-public-api.ts

@@ -0,0 +1,463 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { ApplySignatureRequest } from '../models';
+// @ts-ignore
+import type { DeclineSignatureRequest } from '../models';
+// @ts-ignore
+import type { PublicSignatureView } from '../models';
+/**
+ * DigitalSignaturePublicApi - axios parameter creator
+ */
+export const DigitalSignaturePublicApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Decline to sign (voids the envelope)
+         * @param {string} token 
+         * @param {DeclineSignatureRequest} [declineSignatureRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        decline1: async (token: string, declineSignatureRequest?: DeclineSignatureRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'token' is not null or undefined
+            assertParamExists('decline1', 'token', token)
+            const localVarPath = `/api/v1/public/signatures/decline`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (token !== undefined) {
+                localVarQueryParameter['token'] = token;
+            }
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(declineSignatureRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Stream the source PDF for signing
+         * @param {string} token 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        document: async (token: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'token' is not null or undefined
+            assertParamExists('document', 'token', token)
+            const localVarPath = `/api/v1/public/signatures/document`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (token !== undefined) {
+                localVarQueryParameter['token'] = token;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/pdf';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Record that the recipient opened the document
+         * @param {string} token 
+         * @param {string} [userAgent] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        markViewed: async (token: string, userAgent?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'token' is not null or undefined
+            assertParamExists('markViewed', 'token', token)
+            const localVarPath = `/api/v1/public/signatures/viewed`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (token !== undefined) {
+                localVarQueryParameter['token'] = token;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            if (userAgent != null) {
+                localVarHeaderParameter['User-Agent'] = String(userAgent);
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Apply the recipient\'s signature
+         * @param {string} token 
+         * @param {ApplySignatureRequest} applySignatureRequest 
+         * @param {string} [userAgent] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sign: async (token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'token' is not null or undefined
+            assertParamExists('sign', 'token', token)
+            // verify required parameter 'applySignatureRequest' is not null or undefined
+            assertParamExists('sign', 'applySignatureRequest', applySignatureRequest)
+            const localVarPath = `/api/v1/public/signatures/sign`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (token !== undefined) {
+                localVarQueryParameter['token'] = token;
+            }
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            if (userAgent != null) {
+                localVarHeaderParameter['User-Agent'] = String(userAgent);
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(applySignatureRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Resolve a signing token to its envelope view
+         * @param {string} token 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        view: async (token: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'token' is not null or undefined
+            assertParamExists('view', 'token', token)
+            const localVarPath = `/api/v1/public/signatures`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (token !== undefined) {
+                localVarQueryParameter['token'] = token;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DigitalSignaturePublicApi - functional programming interface
+ */
+export const DigitalSignaturePublicApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DigitalSignaturePublicApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary Decline to sign (voids the envelope)
+         * @param {string} token 
+         * @param {DeclineSignatureRequest} [declineSignatureRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async decline1(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.decline1(token, declineSignatureRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.decline1']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Stream the source PDF for signing
+         * @param {string} token 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async document(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.document(token, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.document']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Record that the recipient opened the document
+         * @param {string} token 
+         * @param {string} [userAgent] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.markViewed(token, userAgent, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.markViewed']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Apply the recipient\'s signature
+         * @param {string} token 
+         * @param {ApplySignatureRequest} applySignatureRequest 
+         * @param {string} [userAgent] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.sign(token, applySignatureRequest, userAgent, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.sign']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Resolve a signing token to its envelope view
+         * @param {string} token 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async view(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.view(token, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.view']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * DigitalSignaturePublicApi - factory interface
+ */
+export const DigitalSignaturePublicApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DigitalSignaturePublicApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary Decline to sign (voids the envelope)
+         * @param {string} token 
+         * @param {DeclineSignatureRequest} [declineSignatureRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        decline1(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
+            return localVarFp.decline1(token, declineSignatureRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Stream the source PDF for signing
+         * @param {string} token 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        document(token: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
+            return localVarFp.document(token, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Record that the recipient opened the document
+         * @param {string} token 
+         * @param {string} [userAgent] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
+            return localVarFp.markViewed(token, userAgent, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Apply the recipient\'s signature
+         * @param {string} token 
+         * @param {ApplySignatureRequest} applySignatureRequest 
+         * @param {string} [userAgent] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
+            return localVarFp.sign(token, applySignatureRequest, userAgent, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Resolve a signing token to its envelope view
+         * @param {string} token 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        view(token: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
+            return localVarFp.view(token, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DigitalSignaturePublicApi - object-oriented interface
+ */
+export class DigitalSignaturePublicApi extends BaseAPI {
+    /**
+     * 
+     * @summary Decline to sign (voids the envelope)
+     * @param {string} token 
+     * @param {DeclineSignatureRequest} [declineSignatureRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public decline1(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig) {
+        return DigitalSignaturePublicApiFp(this.configuration).decline1(token, declineSignatureRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Stream the source PDF for signing
+     * @param {string} token 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public document(token: string, options?: RawAxiosRequestConfig) {
+        return DigitalSignaturePublicApiFp(this.configuration).document(token, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Record that the recipient opened the document
+     * @param {string} token 
+     * @param {string} [userAgent] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig) {
+        return DigitalSignaturePublicApiFp(this.configuration).markViewed(token, userAgent, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Apply the recipient\'s signature
+     * @param {string} token 
+     * @param {ApplySignatureRequest} applySignatureRequest 
+     * @param {string} [userAgent] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig) {
+        return DigitalSignaturePublicApiFp(this.configuration).sign(token, applySignatureRequest, userAgent, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Resolve a signing token to its envelope view
+     * @param {string} token 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public view(token: string, options?: RawAxiosRequestConfig) {
+        return DigitalSignaturePublicApiFp(this.configuration).view(token, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/api.ts

@@ -20,6 +20,8 @@ export * from './api/comments-api';
 export * from './api/dashboard-api';
 export * from './api/delegated-browse-grants-admin-api';
 export * from './api/delegated-browse-grants-end-user-api';
+export * from './api/digital-signature-api';
+export * from './api/digital-signature-public-api';
 export * from './api/document-controller-api';
 export * from './api/document-suggestion-controller-api';
 export * from './api/favorites-api';