@openfilz-sdk/typescript-ee 1.9.2 → 1.9.4

package/docs/PdfOperationResponse.md

@@ -0,0 +1,23 @@
+# PdfOperationResponse
+
+Result of a PDF operation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operation** | **string** |  | [optional] [default to undefined]
+**outputs** | [**Array<PdfOutputInfo>**](PdfOutputInfo.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PdfOperationResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: PdfOperationResponse = {
+    operation,
+    outputs,
+};
+```
+
+[[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/PdfOutlineEntry.md

@@ -0,0 +1,25 @@
+# PdfOutlineEntry
+
+One bookmark of a PDF
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**level** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PdfOutlineEntry } from '@openfilz-sdk/typescript-ee';
+
+const instance: PdfOutlineEntry = {
+    title,
+    page,
+    level,
+};
+```
+
+[[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/PdfOutputInfo.md

@@ -0,0 +1,29 @@
+# PdfOutputInfo
+
+A document produced by a PDF operation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**pageCount** | **number** |  | [optional] [default to undefined]
+**size** | **number** |  | [optional] [default to undefined]
+**versionId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PdfOutputInfo } from '@openfilz-sdk/typescript-ee';
+
+const instance: PdfOutputInfo = {
+    documentId,
+    name,
+    pageCount,
+    size,
+    versionId,
+};
+```
+
+[[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/PdfPageInfo.md

@@ -0,0 +1,27 @@
+# PdfPageInfo
+
+One page of a PDF
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number** | **number** |  | [optional] [default to undefined]
+**width** | **number** |  | [optional] [default to undefined]
+**height** | **number** |  | [optional] [default to undefined]
+**rotation** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PdfPageInfo } from '@openfilz-sdk/typescript-ee';
+
+const instance: PdfPageInfo = {
+    number,
+    width,
+    height,
+    rotation,
+};
+```
+
+[[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/PdfTransformAudit.md

@@ -0,0 +1,27 @@
+# PdfTransformAudit
+
+type=pdfTransform
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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** | Name of the output document | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PdfTransformAudit } from '@openfilz-sdk/typescript-ee';
+
+const instance: PdfTransformAudit = {
+    operation,
+    sourceDocumentIds,
+    pageCount,
+    filename,
+};
+```
+
+[[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/RotateRequest.md

@@ -0,0 +1,27 @@
+# RotateRequest
+
+Rotate pages of one or several PDFs
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentIds** | **Array<string>** | PDF documents to rotate | [default to undefined]
+**angle** | **number** | Clockwise rotation: 90, 180 or 270 | [default to undefined]
+**pages** | **string** | Page selection (e.g. \"1-3,7\", odd, even); null = every page | [optional] [default to undefined]
+**output** | [**OutputTarget**](OutputTarget.md) | Destination; null = new version of each document | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RotateRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: RotateRequest = {
+    documentIds,
+    angle,
+    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/Settings.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **aiActive** | **boolean** |  | [optional] [default to undefined]
 **aiUserSettingsEnabled** | **boolean** |  | [optional] [default to undefined]
 **signatureActive** | **boolean** |  | [optional] [default to undefined]
+**pdfToolsActive** | **boolean** |  | [optional] [default to undefined]
 **signatureRequesterRoleRequired** | **boolean** |  | [optional] [default to undefined]
 **signatureAuthMethods** | **Array<string>** |  | [optional] [default to undefined]
 **signatureRemindersActive** | **boolean** |  | [optional] [default to undefined]
@@ -41,6 +42,7 @@ const instance: Settings = {
     aiActive,
     aiUserSettingsEnabled,
     signatureActive,
+    pdfToolsActive,
     signatureRequesterRoleRequired,
     signatureAuthMethods,
     signatureRemindersActive,

package/docs/SplitOutput.md

@@ -0,0 +1,27 @@
+# SplitOutput
+
+Destination of the parts of a split
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folderId** | **string** | Target folder; null = folder of the source | [optional] [default to undefined]
+**namePattern** | **string** | Name pattern with {name}, {index}, {first}, {last}, {title}; default \"{name}-{index}\" | [optional] [default to undefined]
+**createSubfolder** | **boolean** | Create a sub-folder named after the source for the parts (default false) | [optional] [default to undefined]
+**allowDuplicateFileNames** | **boolean** | Allow names already present in the folder (default false) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SplitOutput } from '@openfilz-sdk/typescript-ee';
+
+const instance: SplitOutput = {
+    folderId,
+    namePattern,
+    createSubfolder,
+    allowDuplicateFileNames,
+};
+```
+
+[[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/SplitRequest.md

@@ -0,0 +1,33 @@
+# SplitRequest
+
+Split a PDF into several documents
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** | PDF document to split | [default to undefined]
+**mode** | **string** | Split mode | [default to undefined]
+**n** | **number** | EVERY_N_PAGES: pages per part | [optional] [default to undefined]
+**pages** | **Array<number>** | AT_PAGES: pages at which a new part starts | [optional] [default to undefined]
+**ranges** | **Array<string>** | PAGE_RANGES: one page selection per part | [optional] [default to undefined]
+**outlineLevel** | **number** | BY_OUTLINE_LEVEL: deepest bookmark level starting a part (default 1) | [optional] [default to undefined]
+**output** | [**SplitOutput**](SplitOutput.md) | Destination of the parts | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SplitRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: SplitRequest = {
+    documentId,
+    mode,
+    n,
+    pages,
+    ranges,
+    outlineLevel,
+    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/models/enriched-audit-log-details.ts

@@ -33,6 +33,9 @@ import type { DeleteMetadataAudit } from './delete-metadata-audit';
 import type { MoveAudit } from './move-audit';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { PdfTransformAudit } from './pdf-transform-audit';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { RenameAudit } from './rename-audit';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -50,6 +53,6 @@ import type { UploadAudit } from './upload-audit';
 /**
  * @type EnrichedAuditLogDetails
  */
-export type EnrichedAuditLogDetails = { type: 'copy' } & CopyAudit | { type: 'createFolder' } & CreateFolderAudit | { type: 'delete' } & DeleteAudit | { type: 'deleteMetadata' } & DeleteMetadataAudit | { type: 'move' } & MoveAudit | { type: 'rename' } & RenameAudit | { type: 'replace' } & ReplaceAudit | { type: 'restoreVersion' } & RestoreVersionAudit | { type: 'updateMetadata' } & UpdateMetadataAudit | { type: 'upload' } & UploadAudit;
+export type EnrichedAuditLogDetails = { type: 'copy' } & CopyAudit | { type: 'createFolder' } & CreateFolderAudit | { type: 'delete' } & DeleteAudit | { type: 'deleteMetadata' } & DeleteMetadataAudit | { type: 'move' } & MoveAudit | { type: 'pdfTransform' } & PdfTransformAudit | { type: 'rename' } & RenameAudit | { type: 'replace' } & ReplaceAudit | { type: 'restoreVersion' } & RestoreVersionAudit | { type: 'updateMetadata' } & UpdateMetadataAudit | { type: 'upload' } & UploadAudit;
 
 

package/models/enriched-audit-log.ts

@@ -57,6 +57,7 @@ export const EnrichedAuditLogActionEnum = {
     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/models/index.ts

@@ -53,11 +53,22 @@ export * from './license-info';
 export * from './list-ai-models-request';
 export * from './mcp-agent-token-info';
 export * from './mcp-agent-token-response';
+export * from './merge-request';
+export * from './merge-source';
 export * from './mint-mcp-agent-token-request';
 export * from './mint-upload-token-request';
 export * from './move-audit';
 export * from './move-request';
 export * from './notification-dto';
+export * from './organize-request';
+export * from './output-target';
+export * from './page-instruction';
+export * from './pdf-info';
+export * from './pdf-operation-response';
+export * from './pdf-outline-entry';
+export * from './pdf-output-info';
+export * from './pdf-page-info';
+export * from './pdf-transform-audit';
 export * from './public-signature-view';
 export * from './rename-audit';
 export * from './rename-request';
@@ -66,6 +77,7 @@ export * from './response';
 export * from './restore-version-audit';
 export * from './restore-version-response';
 export * from './role-binding';
+export * from './rotate-request';
 export * from './save-ai-settings-request';
 export * from './scan-job-status-dto';
 export * from './scan-request-dto';
@@ -92,6 +104,8 @@ export * from './signature-template-field';
 export * from './signature-template-request';
 export * from './signature-template-role';
 export * from './sort-input';
+export * from './split-output';
+export * from './split-request';
 export * from './storage-breakdown';
 export * from './suggest';
 export * from './team-member-info';

package/models/merge-request.ts

@@ -0,0 +1,40 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MergeSource } from './merge-source';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OutputTarget } from './output-target';
+
+/**
+ * Merge PDFs into one document
+ */
+export interface MergeRequest {
+    /**
+     * Ordered source documents
+     */
+    'sources': Array<MergeSource>;
+    /**
+     * Add a bookmark per source (default false)
+     */
+    'addOutline'?: boolean;
+    /**
+     * Destination; null = new document in the folder of the first source
+     */
+    'output'?: OutputTarget;
+}
+

package/models/merge-source.ts

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+
+/**
+ * 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/models/organize-request.ts

@@ -0,0 +1,40 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OutputTarget } from './output-target';
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/output-target.ts

@@ -0,0 +1,50 @@
+/* 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.
+ */
+
+
+
+/**
+ * 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 const OutputTargetModeEnum = {
+    NewDocument: 'NEW_DOCUMENT',
+    NewVersion: 'NEW_VERSION',
+} as const;
+
+export type OutputTargetModeEnum = typeof OutputTargetModeEnum[keyof typeof OutputTargetModeEnum];
+
+

package/models/page-instruction.ts

@@ -0,0 +1,34 @@
+/* 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.
+ */
+
+
+
+/**
+ * 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/models/pdf-info.ts

@@ -0,0 +1,37 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PdfOutlineEntry } from './pdf-outline-entry';
+// May contain unused imports in some cases
+// @ts-ignore
+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;
+    'activeSignatureEnvelope'?: boolean;
+    'outline'?: Array<PdfOutlineEntry>;
+}
+

package/models/pdf-operation-response.ts

@@ -0,0 +1,27 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PdfOutputInfo } from './pdf-output-info';
+
+/**
+ * Result of a PDF operation
+ */
+export interface PdfOperationResponse {
+    'operation'?: string;
+    'outputs'?: Array<PdfOutputInfo>;
+}
+

package/models/pdf-outline-entry.ts

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

package/models/pdf-output-info.ts

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

package/models/pdf-page-info.ts

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