@openfilz-sdk/typescript-ee 1.3.5

package/dist/esm/models/replace-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/scan-job-status-dto.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.
+ */
+export interface ScanJobStatusDto {
+    'jobId'?: string;
+    'scannerId'?: string;
+    'state'?: string;
+    'documentId'?: string;
+    'error'?: string;
+    'startedAt'?: string;
+    'completedAt'?: string;
+}

package/dist/esm/models/scan-job-status-dto.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/scan-request-dto.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 interface ScanRequestDto {
+    'resolution'?: number;
+    'colorMode'?: string;
+    'format'?: string;
+    'targetFolderPath'?: string;
+    'targetFolderId'?: string;
+}

package/dist/esm/models/scan-request-dto.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/scanner-info-dto.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 interface ScannerInfoDto {
+    'id'?: string;
+    'name'?: string;
+    'model'?: string;
+    'manufacturer'?: string;
+    'baseUrl'?: string;
+    'available'?: boolean;
+    'supportedFormats'?: Array<string>;
+    'supportedResolutions'?: Array<number>;
+    'supportedColorModes'?: Array<string>;
+}

package/dist/esm/models/scanner-info-dto.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

@@ -0,0 +1,76 @@
+/**
+ * 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.
+ */
+/**
+ * Documents matching all provided criteria will be returned
+ */
+export interface SearchByAuditLogRequest {
+    /**
+     * Username who made the action
+     */
+    'username'?: string;
+    /**
+     * Document ID to search for
+     */
+    'id'?: string;
+    /**
+     * Type of the document to search - if not provided or null : search all types
+     */
+    'type'?: SearchByAuditLogRequestTypeEnum;
+    /**
+     * Action to search for - if not provided or null : search all actions
+     */
+    'action'?: SearchByAuditLogRequestActionEnum;
+    /**
+     * Audit Metadata key-value pairs to search for
+     */
+    'details'?: {
+        [key: string]: any;
+    };
+}
+export declare const SearchByAuditLogRequestTypeEnum: {
+    readonly File: "FILE";
+    readonly Folder: "FOLDER";
+};
+export type SearchByAuditLogRequestTypeEnum = typeof SearchByAuditLogRequestTypeEnum[keyof typeof SearchByAuditLogRequestTypeEnum];
+export declare const SearchByAuditLogRequestActionEnum: {
+    readonly CopyFile: "COPY_FILE";
+    readonly CopyFileChild: "COPY_FILE_CHILD";
+    readonly RenameFile: "RENAME_FILE";
+    readonly RenameFolder: "RENAME_FOLDER";
+    readonly CopyFolder: "COPY_FOLDER";
+    readonly DeleteFile: "DELETE_FILE";
+    readonly DeleteFileChild: "DELETE_FILE_CHILD";
+    readonly DeleteFolder: "DELETE_FOLDER";
+    readonly CreateFolder: "CREATE_FOLDER";
+    readonly MoveFile: "MOVE_FILE";
+    readonly MoveFolder: "MOVE_FOLDER";
+    readonly UploadDocument: "UPLOAD_DOCUMENT";
+    readonly ReplaceDocumentContent: "REPLACE_DOCUMENT_CONTENT";
+    readonly ReplaceDocumentMetadata: "REPLACE_DOCUMENT_METADATA";
+    readonly UpdateDocumentMetadata: "UPDATE_DOCUMENT_METADATA";
+    readonly DownloadDocument: "DOWNLOAD_DOCUMENT";
+    readonly DeleteDocumentMetadata: "DELETE_DOCUMENT_METADATA";
+    readonly ShareDocuments: "SHARE_DOCUMENTS";
+    readonly ShareDocumentCreate: "SHARE_DOCUMENT_CREATE";
+    readonly ShareDocumentUpdate: "SHARE_DOCUMENT_UPDATE";
+    readonly ShareDocumentDelete: "SHARE_DOCUMENT_DELETE";
+    readonly RestoreFile: "RESTORE_FILE";
+    readonly RestoreFolder: "RESTORE_FOLDER";
+    readonly PermanentDeleteFile: "PERMANENT_DELETE_FILE";
+    readonly PermanentDeleteFolder: "PERMANENT_DELETE_FOLDER";
+    readonly CommentCreate: "COMMENT_CREATE";
+    readonly CommentUpdate: "COMMENT_UPDATE";
+    readonly CommentDelete: "COMMENT_DELETE";
+    readonly EmptyRecycleBin: "EMPTY_RECYCLE_BIN";
+    readonly ChainGenesis: "CHAIN_GENESIS";
+};
+export type SearchByAuditLogRequestActionEnum = typeof SearchByAuditLogRequestActionEnum[keyof typeof SearchByAuditLogRequestActionEnum];

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

@@ -0,0 +1,49 @@
+/* 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 SearchByAuditLogRequestTypeEnum = {
+    File: 'FILE',
+    Folder: 'FOLDER'
+};
+export const SearchByAuditLogRequestActionEnum = {
+    CopyFile: 'COPY_FILE',
+    CopyFileChild: 'COPY_FILE_CHILD',
+    RenameFile: 'RENAME_FILE',
+    RenameFolder: 'RENAME_FOLDER',
+    CopyFolder: 'COPY_FOLDER',
+    DeleteFile: 'DELETE_FILE',
+    DeleteFileChild: 'DELETE_FILE_CHILD',
+    DeleteFolder: 'DELETE_FOLDER',
+    CreateFolder: 'CREATE_FOLDER',
+    MoveFile: 'MOVE_FILE',
+    MoveFolder: 'MOVE_FOLDER',
+    UploadDocument: 'UPLOAD_DOCUMENT',
+    ReplaceDocumentContent: 'REPLACE_DOCUMENT_CONTENT',
+    ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
+    UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
+    DownloadDocument: 'DOWNLOAD_DOCUMENT',
+    DeleteDocumentMetadata: 'DELETE_DOCUMENT_METADATA',
+    ShareDocuments: 'SHARE_DOCUMENTS',
+    ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
+    ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
+    ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
+    RestoreFile: 'RESTORE_FILE',
+    RestoreFolder: 'RESTORE_FOLDER',
+    PermanentDeleteFile: 'PERMANENT_DELETE_FILE',
+    PermanentDeleteFolder: 'PERMANENT_DELETE_FOLDER',
+    CommentCreate: 'COMMENT_CREATE',
+    CommentUpdate: 'COMMENT_UPDATE',
+    CommentDelete: 'COMMENT_DELETE',
+    EmptyRecycleBin: 'EMPTY_RECYCLE_BIN',
+    ChainGenesis: 'CHAIN_GENESIS'
+};

package/dist/esm/models/search-by-metadata-request.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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.
+ */
+/**
+ * Documents matching all provided criteria will be returned
+ */
+export interface SearchByMetadataRequest {
+    /**
+     * Optional : Name of the file - if not provided or null : search all file names
+     */
+    'name'?: string;
+    /**
+     * Optional : Type of the document to search - if not provided or null : search all types
+     */
+    'type'?: SearchByMetadataRequestTypeEnum;
+    /**
+     * Optional : UUID of the parent folder to search - if not provided or null : search in all folders
+     */
+    'parentFolderId'?: string;
+    /**
+     * Optional : if true : search only at the root level - if not provided or null : search in all folders
+     */
+    'rootOnly'?: boolean;
+    /**
+     * Metadata key-value pairs to search for
+     */
+    'metadataCriteria'?: {
+        [key: string]: any;
+    };
+}
+export declare const SearchByMetadataRequestTypeEnum: {
+    readonly File: "FILE";
+    readonly Folder: "FOLDER";
+};
+export type SearchByMetadataRequestTypeEnum = typeof SearchByMetadataRequestTypeEnum[keyof typeof SearchByMetadataRequestTypeEnum];

package/dist/esm/models/search-by-metadata-request.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 SearchByMetadataRequestTypeEnum = {
+    File: 'FILE',
+    Folder: 'FOLDER'
+};

package/dist/esm/models/search-metadata-request.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.
+ */
+export interface SearchMetadataRequest {
+    /**
+     * Optional list of metadata keys to retrieve. If empty or null, all metadata are returned.
+     */
+    'metadataKeys'?: Array<string>;
+}

package/dist/esm/models/search-metadata-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/settings.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.
+ */
+export interface Settings {
+    'emptyBinInterval'?: number;
+    'fileQuotaMB'?: number;
+    'userQuotaMB'?: number;
+    'language'?: string;
+    'theme'?: string;
+    'thumbnailsActive'?: boolean;
+}

package/dist/esm/models/settings.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/share-request.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 interface ShareRequest {
+    /**
+     * How to share documents with users
+     */
+    'shareMode': ShareRequestShareModeEnum;
+    /**
+     * Document IDs to share
+     */
+    'documentIds': Set<string>;
+    /**
+     * User IDs to share with
+     */
+    'userIds': Set<string>;
+    /**
+     * Optional message to include in the share notification
+     */
+    'message'?: string;
+}
+export declare const ShareRequestShareModeEnum: {
+    readonly Reader: "READER";
+    readonly Commenter: "COMMENTER";
+    readonly Editor: "EDITOR";
+};
+export type ShareRequestShareModeEnum = typeof ShareRequestShareModeEnum[keyof typeof ShareRequestShareModeEnum];

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

@@ -0,0 +1,18 @@
+/* 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 ShareRequestShareModeEnum = {
+    Reader: 'READER',
+    Commenter: 'COMMENTER',
+    Editor: 'EDITOR'
+};

package/dist/esm/models/share-result-error.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.
+ */
+export interface ShareResultError {
+    'documentId'?: string;
+    'userId'?: string;
+    'code'?: ShareResultErrorCodeEnum;
+}
+export declare const ShareResultErrorCodeEnum: {
+    readonly ShareErrUserDeactivated: "SHARE_ERR_USER_DEACTIVATED";
+    readonly ShareErrUserNotLicensed: "SHARE_ERR_USER_NOT_LICENSED";
+    readonly ShareErrParentAndChild: "SHARE_ERR_PARENT_AND_CHILD";
+    readonly ShareErrAlreadyExists: "SHARE_ERR_ALREADY_EXISTS";
+    readonly ShareErrNotAlreadyShared: "SHARE_ERR_NOT_ALREADY_SHARED";
+    readonly ShareErrOwner: "SHARE_ERR_OWNER";
+    readonly ShareErrNotScanned: "SHARE_ERR_NOT_SCANNED";
+};
+export type ShareResultErrorCodeEnum = typeof ShareResultErrorCodeEnum[keyof typeof ShareResultErrorCodeEnum];

package/dist/esm/models/share-result-error.js

@@ -0,0 +1,22 @@
+/* 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 ShareResultErrorCodeEnum = {
+    ShareErrUserDeactivated: 'SHARE_ERR_USER_DEACTIVATED',
+    ShareErrUserNotLicensed: 'SHARE_ERR_USER_NOT_LICENSED',
+    ShareErrParentAndChild: 'SHARE_ERR_PARENT_AND_CHILD',
+    ShareErrAlreadyExists: 'SHARE_ERR_ALREADY_EXISTS',
+    ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
+    ShareErrOwner: 'SHARE_ERR_OWNER',
+    ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED'
+};

package/dist/esm/models/share-result-item.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.
+ */
+export interface ShareResultItem {
+    'documentId'?: string;
+    'userId'?: string;
+}

package/dist/esm/models/share-result-item.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/share-result-response.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { ShareResultError } from './share-result-error';
+import type { ShareResultItem } from './share-result-item';
+export interface ShareResultResponse {
+    'ok'?: Array<ShareResultItem>;
+    'requested'?: Array<ShareResultItem>;
+    'errors'?: Array<ShareResultError>;
+}

package/dist/esm/models/share-result-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/sort-input.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.
+ */
+export interface SortInput {
+    'field'?: string;
+    'order'?: SortInputOrderEnum;
+}
+export declare const SortInputOrderEnum: {
+    readonly Asc: "ASC";
+    readonly Desc: "DESC";
+};
+export type SortInputOrderEnum = typeof SortInputOrderEnum[keyof typeof SortInputOrderEnum];

package/dist/esm/models/sort-input.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 SortInputOrderEnum = {
+    Asc: 'ASC',
+    Desc: 'DESC'
+};

package/dist/esm/models/storage-breakdown.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 { FileTypeStats } from './file-type-stats';
+export interface StorageBreakdown {
+    'totalStorageUsed'?: number;
+    'totalStorageAvailable'?: number;
+    'fileTypeBreakdown'?: Array<FileTypeStats>;
+}

package/dist/esm/models/storage-breakdown.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/suggest.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.
+ */
+export interface Suggest {
+    'id'?: string;
+    's'?: string;
+    'ext'?: string;
+    'contentSnippet'?: string;
+}

package/dist/esm/models/suggest.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 {};