@openfilz-sdk/typescript-ee 1.9.1 → 1.9.3

package/dist/esm/api/feature-entitlements-api.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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 { type RequestArgs, BaseAPI } from '../base';
+import type { Response } from '../models';
+/**
+ * FeatureEntitlementsApi - axios parameter creator
+ */
+export declare const FeatureEntitlementsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
+     * @summary Deployment + licence state per optional feature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFeatureEntitlements: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FeatureEntitlementsApi - functional programming interface
+ */
+export declare const FeatureEntitlementsApiFp: (configuration?: Configuration) => {
+    /**
+     * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
+     * @summary Deployment + licence state per optional feature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFeatureEntitlements(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Response>>;
+};
+/**
+ * FeatureEntitlementsApi - factory interface
+ */
+export declare const FeatureEntitlementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
+     * @summary Deployment + licence state per optional feature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFeatureEntitlements(options?: RawAxiosRequestConfig): AxiosPromise<Response>;
+};
+/**
+ * FeatureEntitlementsApi - object-oriented interface
+ */
+export declare class FeatureEntitlementsApi extends BaseAPI {
+    /**
+     * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
+     * @summary Deployment + licence state per optional feature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFeatureEntitlements(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Response, any, {}, any>>;
+}

package/dist/esm/api/feature-entitlements-api.js

@@ -0,0 +1,118 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
+/**
+ * FeatureEntitlementsApi - axios parameter creator
+ */
+export const FeatureEntitlementsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
+         * @summary Deployment + licence state per optional feature
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFeatureEntitlements: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/v1/admin/features`;
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * FeatureEntitlementsApi - functional programming interface
+ */
+export const FeatureEntitlementsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = FeatureEntitlementsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
+         * @summary Deployment + licence state per optional feature
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFeatureEntitlements(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getFeatureEntitlements(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FeatureEntitlementsApi.getFeatureEntitlements']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * FeatureEntitlementsApi - factory interface
+ */
+export const FeatureEntitlementsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = FeatureEntitlementsApiFp(configuration);
+    return {
+        /**
+         * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
+         * @summary Deployment + licence state per optional feature
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFeatureEntitlements(options) {
+            return localVarFp.getFeatureEntitlements(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * FeatureEntitlementsApi - object-oriented interface
+ */
+export class FeatureEntitlementsApi extends BaseAPI {
+    /**
+     * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
+     * @summary Deployment + licence state per optional feature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFeatureEntitlements(options) {
+        return FeatureEntitlementsApiFp(this.configuration).getFeatureEntitlements(options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/api/pdftools-api.d.ts

@@ -0,0 +1,200 @@
+/**
+ * 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 { type RequestArgs, BaseAPI } from '../base';
+import type { MergeRequest } from '../models';
+import type { OrganizeRequest } from '../models';
+import type { PdfInfo } from '../models';
+import type { PdfOperationResponse } from '../models';
+import type { RotateRequest } from '../models';
+import type { SplitRequest } from '../models';
+/**
+ * PDFToolsApi - axios parameter creator
+ */
+export declare const PDFToolsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Page count and geometry, bookmarks, and whether the file is password-protected or digitally signed.
+     * @summary Describe a stored PDF
+     * @param {string} documentId PDF document id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    info: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Concatenate several PDFs (or page selections of them) into one document, in the given order, optionally with one bookmark per source. Default output: a new document next to the first source.
+     * @summary Merge PDFs
+     * @param {MergeRequest} mergeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    merge: (mergeRequest: MergeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * The result is exactly the listed pages, in order: reorder, delete, duplicate, rotate individual pages, extract a selection, or insert pages from other PDFs. Default output: a new version of the main document.
+     * @summary Reorganise the pages of a PDF
+     * @param {OrganizeRequest} organizeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    organize: (organizeRequest: OrganizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Rotate all or selected pages of one or several PDFs by 90, 180 or 270 degrees, one output per document. Default output: a new version of each document.
+     * @summary Rotate pages
+     * @param {RotateRequest} rotateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rotate: (rotateRequest: RotateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Cut one PDF into several new documents: every N pages, at given pages, by explicit page ranges, one document per page, or at bookmarks. Names follow a pattern ({name}, {index}, {first}, {last}, {title}).
+     * @summary Split a PDF
+     * @param {SplitRequest} splitRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    split: (splitRequest: SplitRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PDFToolsApi - functional programming interface
+ */
+export declare const PDFToolsApiFp: (configuration?: Configuration) => {
+    /**
+     * Page count and geometry, bookmarks, and whether the file is password-protected or digitally signed.
+     * @summary Describe a stored PDF
+     * @param {string} documentId PDF document id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    info(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfInfo>>;
+    /**
+     * Concatenate several PDFs (or page selections of them) into one document, in the given order, optionally with one bookmark per source. Default output: a new document next to the first source.
+     * @summary Merge PDFs
+     * @param {MergeRequest} mergeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    merge(mergeRequest: MergeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfOperationResponse>>;
+    /**
+     * The result is exactly the listed pages, in order: reorder, delete, duplicate, rotate individual pages, extract a selection, or insert pages from other PDFs. Default output: a new version of the main document.
+     * @summary Reorganise the pages of a PDF
+     * @param {OrganizeRequest} organizeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    organize(organizeRequest: OrganizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfOperationResponse>>;
+    /**
+     * Rotate all or selected pages of one or several PDFs by 90, 180 or 270 degrees, one output per document. Default output: a new version of each document.
+     * @summary Rotate pages
+     * @param {RotateRequest} rotateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rotate(rotateRequest: RotateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfOperationResponse>>;
+    /**
+     * Cut one PDF into several new documents: every N pages, at given pages, by explicit page ranges, one document per page, or at bookmarks. Names follow a pattern ({name}, {index}, {first}, {last}, {title}).
+     * @summary Split a PDF
+     * @param {SplitRequest} splitRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    split(splitRequest: SplitRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfOperationResponse>>;
+};
+/**
+ * PDFToolsApi - factory interface
+ */
+export declare const PDFToolsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Page count and geometry, bookmarks, and whether the file is password-protected or digitally signed.
+     * @summary Describe a stored PDF
+     * @param {string} documentId PDF document id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    info(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PdfInfo>;
+    /**
+     * Concatenate several PDFs (or page selections of them) into one document, in the given order, optionally with one bookmark per source. Default output: a new document next to the first source.
+     * @summary Merge PDFs
+     * @param {MergeRequest} mergeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    merge(mergeRequest: MergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfOperationResponse>;
+    /**
+     * The result is exactly the listed pages, in order: reorder, delete, duplicate, rotate individual pages, extract a selection, or insert pages from other PDFs. Default output: a new version of the main document.
+     * @summary Reorganise the pages of a PDF
+     * @param {OrganizeRequest} organizeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    organize(organizeRequest: OrganizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfOperationResponse>;
+    /**
+     * Rotate all or selected pages of one or several PDFs by 90, 180 or 270 degrees, one output per document. Default output: a new version of each document.
+     * @summary Rotate pages
+     * @param {RotateRequest} rotateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rotate(rotateRequest: RotateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfOperationResponse>;
+    /**
+     * Cut one PDF into several new documents: every N pages, at given pages, by explicit page ranges, one document per page, or at bookmarks. Names follow a pattern ({name}, {index}, {first}, {last}, {title}).
+     * @summary Split a PDF
+     * @param {SplitRequest} splitRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    split(splitRequest: SplitRequest, options?: RawAxiosRequestConfig): AxiosPromise<PdfOperationResponse>;
+};
+/**
+ * PDFToolsApi - object-oriented interface
+ */
+export declare class PDFToolsApi extends BaseAPI {
+    /**
+     * Page count and geometry, bookmarks, and whether the file is password-protected or digitally signed.
+     * @summary Describe a stored PDF
+     * @param {string} documentId PDF document id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    info(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfInfo, any, {}, any>>;
+    /**
+     * Concatenate several PDFs (or page selections of them) into one document, in the given order, optionally with one bookmark per source. Default output: a new document next to the first source.
+     * @summary Merge PDFs
+     * @param {MergeRequest} mergeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    merge(mergeRequest: MergeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfOperationResponse, any, {}, any>>;
+    /**
+     * The result is exactly the listed pages, in order: reorder, delete, duplicate, rotate individual pages, extract a selection, or insert pages from other PDFs. Default output: a new version of the main document.
+     * @summary Reorganise the pages of a PDF
+     * @param {OrganizeRequest} organizeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    organize(organizeRequest: OrganizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfOperationResponse, any, {}, any>>;
+    /**
+     * Rotate all or selected pages of one or several PDFs by 90, 180 or 270 degrees, one output per document. Default output: a new version of each document.
+     * @summary Rotate pages
+     * @param {RotateRequest} rotateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    rotate(rotateRequest: RotateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfOperationResponse, any, {}, any>>;
+    /**
+     * Cut one PDF into several new documents: every N pages, at given pages, by explicit page ranges, one document per page, or at bookmarks. Names follow a pattern ({name}, {index}, {first}, {last}, {title}).
+     * @summary Split a PDF
+     * @param {SplitRequest} splitRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    split(splitRequest: SplitRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfOperationResponse, any, {}, any>>;
+}