@openfilz-sdk/typescript-ee 1.9.1 → 1.9.3

package/dist/models/rotate-request.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 { OutputTarget } from './output-target';
+/**
+ * Rotate pages of one or several PDFs
+ */
+export interface RotateRequest {
+    /**
+     * PDF documents to rotate
+     */
+    'documentIds': Array<string>;
+    /**
+     * Clockwise rotation: 90, 180 or 270
+     */
+    'angle': number;
+    /**
+     * Page selection (e.g. \"1-3,7\", odd, even); null = every page
+     */
+    'pages'?: string;
+    /**
+     * Destination; null = new version of each document
+     */
+    'output'?: OutputTarget;
+}

package/dist/models/rotate-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/search-by-audit-log-request.d.ts

@@ -65,6 +65,7 @@ export declare const SearchByAuditLogRequestActionEnum: {
     readonly PermanentDeleteFile: "PERMANENT_DELETE_FILE";
     readonly PermanentDeleteFolder: "PERMANENT_DELETE_FOLDER";
     readonly EmptyRecycleBin: "EMPTY_RECYCLE_BIN";
+    readonly PdfTransform: "PDF_TRANSFORM";
     readonly ChainGenesis: "CHAIN_GENESIS";
     readonly CommentCreate: "COMMENT_CREATE";
     readonly CommentUpdate: "COMMENT_UPDATE";

package/dist/models/search-by-audit-log-request.js

@@ -42,6 +42,7 @@ exports.SearchByAuditLogRequestActionEnum = {
     PermanentDeleteFile: 'PERMANENT_DELETE_FILE',
     PermanentDeleteFolder: 'PERMANENT_DELETE_FOLDER',
     EmptyRecycleBin: 'EMPTY_RECYCLE_BIN',
+    PdfTransform: 'PDF_TRANSFORM',
     ChainGenesis: 'CHAIN_GENESIS',
     CommentCreate: 'COMMENT_CREATE',
     CommentUpdate: 'COMMENT_UPDATE',

package/dist/models/settings.d.ts

@@ -19,6 +19,7 @@ export interface Settings {
     'aiActive'?: boolean;
     'aiUserSettingsEnabled'?: boolean;
     'signatureActive'?: boolean;
+    'pdfToolsActive'?: boolean;
     'signatureRequesterRoleRequired'?: boolean;
     'signatureAuthMethods'?: Array<string>;
     'signatureRemindersActive'?: boolean;

package/dist/models/split-output.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * Destination of the parts of a split
+ */
+export interface SplitOutput {
+    /**
+     * Target folder; null = folder of the source
+     */
+    'folderId'?: string;
+    /**
+     * Name pattern with {name}, {index}, {first}, {last}, {title}; default \"{name}-{index}\"
+     */
+    'namePattern'?: string;
+    /**
+     * Create a sub-folder named after the source for the parts (default false)
+     */
+    'createSubfolder'?: boolean;
+    /**
+     * Allow names already present in the folder (default false)
+     */
+    'allowDuplicateFileNames'?: boolean;
+}

package/dist/models/split-output.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/split-request.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 { SplitOutput } from './split-output';
+/**
+ * Split a PDF into several documents
+ */
+export interface SplitRequest {
+    /**
+     * PDF document to split
+     */
+    'documentId': string;
+    /**
+     * Split mode
+     */
+    'mode': SplitRequestModeEnum;
+    /**
+     * EVERY_N_PAGES: pages per part
+     */
+    'n'?: number;
+    /**
+     * AT_PAGES: pages at which a new part starts
+     */
+    'pages'?: Array<number>;
+    /**
+     * PAGE_RANGES: one page selection per part
+     */
+    'ranges'?: Array<string>;
+    /**
+     * BY_OUTLINE_LEVEL: deepest bookmark level starting a part (default 1)
+     */
+    'outlineLevel'?: number;
+    /**
+     * Destination of the parts
+     */
+    'output'?: SplitOutput;
+}
+export declare const SplitRequestModeEnum: {
+    readonly EveryNPages: "EVERY_N_PAGES";
+    readonly EveryPage: "EVERY_PAGE";
+    readonly AtPages: "AT_PAGES";
+    readonly PageRanges: "PAGE_RANGES";
+    readonly ByOutlineLevel: "BY_OUTLINE_LEVEL";
+};
+export type SplitRequestModeEnum = typeof SplitRequestModeEnum[keyof typeof SplitRequestModeEnum];

package/dist/models/split-request.js

@@ -0,0 +1,23 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SplitRequestModeEnum = void 0;
+exports.SplitRequestModeEnum = {
+    EveryNPages: 'EVERY_N_PAGES',
+    EveryPage: 'EVERY_PAGE',
+    AtPages: 'AT_PAGES',
+    PageRanges: 'PAGE_RANGES',
+    ByOutlineLevel: 'BY_OUTLINE_LEVEL',
+};

package/docs/EnrichedAuditLogDetails.md

@@ -13,8 +13,11 @@ Name | Type | Description | Notes
 **request** | [**CreateFolderRequest**](CreateFolderRequest.md) |  | [optional] [default to undefined]
 **deletedParentFolderId** | **string** |  | [optional] [default to undefined]
 **deletedMetadataKeys** | **Array<string>** | List of deleted metadata keys | [optional] [default to undefined]
-**name** | **string** | New name of the document | [optional] [default to undefined]
+**operation** | **string** | merge, split, organize or rotate | [optional] [default to undefined]
+**sourceDocumentIds** | **Array<string>** | Source documents the output was built from | [optional] [default to undefined]
+**pageCount** | **number** | Pages in the output | [optional] [default to undefined]
 **filename** | **string** |  | [optional] [default to undefined]
+**name** | **string** | New name of the document | [optional] [default to undefined]
 **metadata** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
 **restoredFromVersionId** | **string** | Version identifier that was restored | [optional] [default to undefined]
 **restoredFromDate** | **string** | Creation date of the restored version | [optional] [default to undefined]
@@ -35,8 +38,11 @@ const instance: EnrichedAuditLogDetails = {
     request,
     deletedParentFolderId,
     deletedMetadataKeys,
-    name,
+    operation,
+    sourceDocumentIds,
+    pageCount,
     filename,
+    name,
     metadata,
     restoredFromVersionId,
     restoredFromDate,

package/docs/FeatureEntitlement.md

@@ -0,0 +1,24 @@
+# FeatureEntitlement
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**feature** | **string** |  | [optional] [default to undefined]
+**deployed** | **boolean** |  | [optional] [default to undefined]
+**licensed** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FeatureEntitlement } from '@openfilz-sdk/typescript-ee';
+
+const instance: FeatureEntitlement = {
+    feature,
+    deployed,
+    licensed,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FeatureEntitlementsApi.md

@@ -0,0 +1,52 @@
+# FeatureEntitlementsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getFeatureEntitlements**](#getfeatureentitlements) | **GET** /api/v1/admin/features | Deployment + licence state per optional feature|
+
+# **getFeatureEntitlements**
+> Response getFeatureEntitlements()
+
+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.
+
+### Example
+
+```typescript
+import {
+    FeatureEntitlementsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new FeatureEntitlementsApi(configuration);
+
+const { status, data } = await apiInstance.getFeatureEntitlements();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Response**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/MergeRequest.md

@@ -0,0 +1,25 @@
+# MergeRequest
+
+Merge PDFs into one document
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sources** | [**Array<MergeSource>**](MergeSource.md) | Ordered source documents | [default to undefined]
+**addOutline** | **boolean** | Add a bookmark per source (default false) | [optional] [default to undefined]
+**output** | [**OutputTarget**](OutputTarget.md) | Destination; null = new document in the folder of the first source | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MergeRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: MergeRequest = {
+    sources,
+    addOutline,
+    output,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MergeSource.md

@@ -0,0 +1,23 @@
+# MergeSource
+
+One source document of a merge
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** | Source PDF document id | [default to undefined]
+**pages** | **string** | Page selection, e.g. \"1-3,7,10-\" (also all/odd/even); null = every page | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MergeSource } from '@openfilz-sdk/typescript-ee';
+
+const instance: MergeSource = {
+    documentId,
+    pages,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrganizeRequest.md

@@ -0,0 +1,25 @@
+# OrganizeRequest
+
+Compose a PDF from an explicit ordered list of pages
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** | Main document | [default to undefined]
+**pages** | [**Array<PageInstruction>**](PageInstruction.md) | Output pages, in order | [default to undefined]
+**output** | [**OutputTarget**](OutputTarget.md) | Destination; null = new version of the main document | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrganizeRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: OrganizeRequest = {
+    documentId,
+    pages,
+    output,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OutputTarget.md

@@ -0,0 +1,29 @@
+# OutputTarget
+
+Destination of the result of a PDF operation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mode** | **string** | NEW_DOCUMENT (default for merge) or NEW_VERSION (default for organize/rotate) | [optional] [default to undefined]
+**folderId** | **string** | NEW_DOCUMENT: target folder; null = folder of the (first) source | [optional] [default to undefined]
+**name** | **string** | NEW_DOCUMENT: file name; null = derived from the (first) source | [optional] [default to undefined]
+**allowDuplicateFileNames** | **boolean** | NEW_DOCUMENT: allow a name already present in the folder (default false) | [optional] [default to undefined]
+**acknowledgeSignatureLoss** | **boolean** | NEW_VERSION: confirm that an existing digital signature may be invalidated | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OutputTarget } from '@openfilz-sdk/typescript-ee';
+
+const instance: OutputTarget = {
+    mode,
+    folderId,
+    name,
+    allowDuplicateFileNames,
+    acknowledgeSignatureLoss,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PDFToolsApi.md

@@ -0,0 +1,271 @@
+# PDFToolsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**info**](#info) | **GET** /api/v1/pdf/{documentId}/info | Describe a stored PDF|
+|[**merge**](#merge) | **POST** /api/v1/pdf/merge | Merge PDFs|
+|[**organize**](#organize) | **POST** /api/v1/pdf/organize | Reorganise the pages of a PDF|
+|[**rotate**](#rotate) | **POST** /api/v1/pdf/rotate | Rotate pages|
+|[**split**](#split) | **POST** /api/v1/pdf/split | Split a PDF|
+
+# **info**
+> PdfInfo info()
+
+Page count and geometry, bookmarks, and whether the file is password-protected or digitally signed.
+
+### Example
+
+```typescript
+import {
+    PDFToolsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new PDFToolsApi(configuration);
+
+let documentId: string; //PDF document id (default to undefined)
+
+const { status, data } = await apiInstance.info(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] | PDF document id | defaults to undefined|
+
+
+### Return type
+
+**PdfInfo**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **merge**
+> PdfOperationResponse merge(mergeRequest)
+
+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.
+
+### Example
+
+```typescript
+import {
+    PDFToolsApi,
+    Configuration,
+    MergeRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new PDFToolsApi(configuration);
+
+let mergeRequest: MergeRequest; //
+
+const { status, data } = await apiInstance.merge(
+    mergeRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mergeRequest** | **MergeRequest**|  | |
+
+
+### Return type
+
+**PdfOperationResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **organize**
+> PdfOperationResponse organize(organizeRequest)
+
+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.
+
+### Example
+
+```typescript
+import {
+    PDFToolsApi,
+    Configuration,
+    OrganizeRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new PDFToolsApi(configuration);
+
+let organizeRequest: OrganizeRequest; //
+
+const { status, data } = await apiInstance.organize(
+    organizeRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizeRequest** | **OrganizeRequest**|  | |
+
+
+### Return type
+
+**PdfOperationResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **rotate**
+> PdfOperationResponse rotate(rotateRequest)
+
+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.
+
+### Example
+
+```typescript
+import {
+    PDFToolsApi,
+    Configuration,
+    RotateRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new PDFToolsApi(configuration);
+
+let rotateRequest: RotateRequest; //
+
+const { status, data } = await apiInstance.rotate(
+    rotateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rotateRequest** | **RotateRequest**|  | |
+
+
+### Return type
+
+**PdfOperationResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **split**
+> PdfOperationResponse split(splitRequest)
+
+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}).
+
+### Example
+
+```typescript
+import {
+    PDFToolsApi,
+    Configuration,
+    SplitRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new PDFToolsApi(configuration);
+
+let splitRequest: SplitRequest; //
+
+const { status, data } = await apiInstance.split(
+    splitRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **splitRequest** | **SplitRequest**|  | |
+
+
+### Return type
+
+**PdfOperationResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+