@openfilz-sdk/typescript-ee 1.9.1 → 1.9.3

package/dist/esm/models/merge-source.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ * One source document of a merge
+ */
+export interface MergeSource {
+    /**
+     * Source PDF document id
+     */
+    'documentId': string;
+    /**
+     * Page selection, e.g. \"1-3,7,10-\" (also all/odd/even); null = every page
+     */
+    'pages'?: string;
+}

package/dist/esm/models/merge-source.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/organize-request.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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';
+import type { PageInstruction } from './page-instruction';
+/**
+ * Compose a PDF from an explicit ordered list of pages
+ */
+export interface OrganizeRequest {
+    /**
+     * Main document
+     */
+    'documentId': string;
+    /**
+     * Output pages, in order
+     */
+    'pages': Array<PageInstruction>;
+    /**
+     * Destination; null = new version of the main document
+     */
+    'output'?: OutputTarget;
+}

package/dist/esm/models/organize-request.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/output-target.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 result of a PDF operation
+ */
+export interface OutputTarget {
+    /**
+     * NEW_DOCUMENT (default for merge) or NEW_VERSION (default for organize/rotate)
+     */
+    'mode'?: OutputTargetModeEnum;
+    /**
+     * NEW_DOCUMENT: target folder; null = folder of the (first) source
+     */
+    'folderId'?: string;
+    /**
+     * NEW_DOCUMENT: file name; null = derived from the (first) source
+     */
+    'name'?: string;
+    /**
+     * NEW_DOCUMENT: allow a name already present in the folder (default false)
+     */
+    'allowDuplicateFileNames'?: boolean;
+    /**
+     * NEW_VERSION: confirm that an existing digital signature may be invalidated
+     */
+    'acknowledgeSignatureLoss'?: boolean;
+}
+export declare const OutputTargetModeEnum: {
+    readonly NewDocument: "NEW_DOCUMENT";
+    readonly NewVersion: "NEW_VERSION";
+};
+export type OutputTargetModeEnum = typeof OutputTargetModeEnum[keyof typeof OutputTargetModeEnum];

package/dist/esm/models/output-target.js

@@ -0,0 +1,17 @@
+/* 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.
+ */
+export const OutputTargetModeEnum = {
+    NewDocument: 'NEW_DOCUMENT',
+    NewVersion: 'NEW_VERSION',
+};

package/dist/esm/models/page-instruction.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+/**
+ * One output page: which source page, with which extra rotation
+ */
+export interface PageInstruction {
+    /**
+     * Source document; null = the main document
+     */
+    'documentId'?: string;
+    /**
+     * 1-based page number in the source
+     */
+    'page'?: number;
+    /**
+     * Extra clockwise rotation: 0, 90, 180 or 270 (default 0)
+     */
+    'rotation'?: number;
+}

package/dist/esm/models/page-instruction.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/pdf-info.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { PdfOutlineEntry } from './pdf-outline-entry';
+import type { PdfPageInfo } from './pdf-page-info';
+/**
+ * Structure of a stored PDF
+ */
+export interface PdfInfo {
+    'documentId'?: string;
+    'name'?: string;
+    'size'?: number;
+    'pageCount'?: number;
+    'pages'?: Array<PdfPageInfo>;
+    'encrypted'?: boolean;
+    'signed'?: boolean;
+    'outline'?: Array<PdfOutlineEntry>;
+}

package/dist/esm/models/pdf-info.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/pdf-operation-response.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 { PdfOutputInfo } from './pdf-output-info';
+/**
+ * Result of a PDF operation
+ */
+export interface PdfOperationResponse {
+    'operation'?: string;
+    'outputs'?: Array<PdfOutputInfo>;
+}

package/dist/esm/models/pdf-operation-response.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/pdf-outline-entry.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+/**
+ * One bookmark of a PDF
+ */
+export interface PdfOutlineEntry {
+    'title'?: string;
+    'page'?: number;
+    'level'?: number;
+}

package/dist/esm/models/pdf-outline-entry.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/pdf-output-info.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+/**
+ * A document produced by a PDF operation
+ */
+export interface PdfOutputInfo {
+    'documentId'?: string;
+    'name'?: string;
+    'pageCount'?: number;
+    'size'?: number;
+    'versionId'?: string;
+}

package/dist/esm/models/pdf-output-info.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/pdf-page-info.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+/**
+ * One page of a PDF
+ */
+export interface PdfPageInfo {
+    'number'?: number;
+    'width'?: number;
+    'height'?: number;
+    'rotation'?: number;
+}

package/dist/esm/models/pdf-page-info.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/pdf-transform-audit.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { AuditLogDetails } from './audit-log-details';
+/**
+ * @type PdfTransformAudit
+ * type=pdfTransform
+ */
+export type PdfTransformAudit = AuditLogDetails;

package/dist/esm/models/pdf-transform-audit.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/response.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 { FeatureEntitlement } from './feature-entitlement';
+export interface Response {
+    'features'?: Array<FeatureEntitlement>;
+}

package/dist/esm/models/response.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/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/esm/models/rotate-request.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/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/esm/models/search-by-audit-log-request.js

@@ -39,6 +39,7 @@ export const 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/esm/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/esm/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/esm/models/split-output.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/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/esm/models/split-request.js

@@ -0,0 +1,20 @@
+/* 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.
+ */
+export const SplitRequestModeEnum = {
+    EveryNPages: 'EVERY_N_PAGES',
+    EveryPage: 'EVERY_PAGE',
+    AtPages: 'AT_PAGES',
+    PageRanges: 'PAGE_RANGES',
+    ByOutlineLevel: 'BY_OUTLINE_LEVEL',
+};

package/dist/models/enriched-audit-log-details.d.ts

@@ -14,6 +14,7 @@ import type { CreateFolderAudit } from './create-folder-audit';
 import type { DeleteAudit } from './delete-audit';
 import type { DeleteMetadataAudit } from './delete-metadata-audit';
 import type { MoveAudit } from './move-audit';
+import type { PdfTransformAudit } from './pdf-transform-audit';
 import type { RenameAudit } from './rename-audit';
 import type { ReplaceAudit } from './replace-audit';
 import type { RestoreVersionAudit } from './restore-version-audit';
@@ -33,6 +34,8 @@ export type EnrichedAuditLogDetails = {
 } & DeleteMetadataAudit | {
     type: 'move';
 } & MoveAudit | {
+    type: 'pdfTransform';
+} & PdfTransformAudit | {
     type: 'rename';
 } & RenameAudit | {
     type: 'replace';

package/dist/models/enriched-audit-log.d.ts

@@ -49,6 +49,7 @@ export declare const EnrichedAuditLogActionEnum: {
     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";