@openfilz-sdk/typescript-ee 1.3.5

package/models/scan-request-dto.ts

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

package/models/scanner-info-dto.ts

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

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

@@ -0,0 +1,84 @@
+/* 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.
+ */
+
+
+
+/**
+ * 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 const SearchByAuditLogRequestTypeEnum = {
+    File: 'FILE',
+    Folder: 'FOLDER'
+} as const;
+
+export type SearchByAuditLogRequestTypeEnum = typeof SearchByAuditLogRequestTypeEnum[keyof typeof SearchByAuditLogRequestTypeEnum];
+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'
+} as const;
+
+export type SearchByAuditLogRequestActionEnum = typeof SearchByAuditLogRequestActionEnum[keyof typeof SearchByAuditLogRequestActionEnum];
+
+

package/models/search-by-metadata-request.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.
+ */
+
+
+
+/**
+ * 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 const SearchByMetadataRequestTypeEnum = {
+    File: 'FILE',
+    Folder: 'FOLDER'
+} as const;
+
+export type SearchByMetadataRequestTypeEnum = typeof SearchByMetadataRequestTypeEnum[keyof typeof SearchByMetadataRequestTypeEnum];
+
+

package/models/search-metadata-request.ts

@@ -0,0 +1,23 @@
+/* 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 interface SearchMetadataRequest {
+    /**
+     * Optional list of metadata keys to retrieve. If empty or null, all metadata are returned.
+     */
+    'metadataKeys'?: Array<string>;
+}
+

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

package/models/share-request.ts

@@ -0,0 +1,44 @@
+/* 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 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 const ShareRequestShareModeEnum = {
+    Reader: 'READER',
+    Commenter: 'COMMENTER',
+    Editor: 'EDITOR'
+} as const;
+
+export type ShareRequestShareModeEnum = typeof ShareRequestShareModeEnum[keyof typeof ShareRequestShareModeEnum];
+
+

package/models/share-result-error.ts

@@ -0,0 +1,35 @@
+/* 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 interface ShareResultError {
+    'documentId'?: string;
+    'userId'?: string;
+    'code'?: ShareResultErrorCodeEnum;
+}
+
+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'
+} as const;
+
+export type ShareResultErrorCodeEnum = typeof ShareResultErrorCodeEnum[keyof typeof ShareResultErrorCodeEnum];
+
+

package/models/share-result-item.ts

@@ -0,0 +1,21 @@
+/* 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 interface ShareResultItem {
+    'documentId'?: string;
+    'userId'?: string;
+}
+

package/models/share-result-response.ts

@@ -0,0 +1,28 @@
+/* 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 { ShareResultError } from './share-result-error';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ShareResultItem } from './share-result-item';
+
+export interface ShareResultResponse {
+    'ok'?: Array<ShareResultItem>;
+    'requested'?: Array<ShareResultItem>;
+    'errors'?: Array<ShareResultError>;
+}
+

package/models/sort-input.ts

@@ -0,0 +1,29 @@
+/* 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 interface SortInput {
+    'field'?: string;
+    'order'?: SortInputOrderEnum;
+}
+
+export const SortInputOrderEnum = {
+    Asc: 'ASC',
+    Desc: 'DESC'
+} as const;
+
+export type SortInputOrderEnum = typeof SortInputOrderEnum[keyof typeof SortInputOrderEnum];
+
+

package/models/storage-breakdown.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { FileTypeStats } from './file-type-stats';
+
+export interface StorageBreakdown {
+    'totalStorageUsed'?: number;
+    'totalStorageAvailable'?: number;
+    'fileTypeBreakdown'?: Array<FileTypeStats>;
+}
+

package/models/suggest.ts

@@ -0,0 +1,23 @@
+/* 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 interface Suggest {
+    'id'?: string;
+    's'?: string;
+    'ext'?: string;
+    'contentSnippet'?: string;
+}
+

package/models/team-member-info.ts

@@ -0,0 +1,32 @@
+/* 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 interface TeamMemberInfo {
+    'id'?: string;
+    'name'?: string;
+    'email'?: string;
+    'status'?: TeamMemberInfoStatusEnum;
+}
+
+export const TeamMemberInfoStatusEnum = {
+    Free: 'FREE',
+    Licensed: 'LICENSED',
+    Deactivated: 'DEACTIVATED'
+} as const;
+
+export type TeamMemberInfoStatusEnum = typeof TeamMemberInfoStatusEnum[keyof typeof TeamMemberInfoStatusEnum];
+
+

package/models/tus-config-response.ts

@@ -0,0 +1,24 @@
+/* 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 interface TusConfigResponse {
+    'enabled'?: boolean;
+    'endpoint'?: string;
+    'maxUploadSize'?: number;
+    'chunkSize'?: number;
+    'uploadExpirationPeriod'?: number;
+}
+

package/models/tus-finalize-request.ts

@@ -0,0 +1,23 @@
+/* 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 interface TusFinalizeRequest {
+    'filename': string;
+    'parentFolderId'?: string;
+    'metadata'?: { [key: string]: any; };
+    'allowDuplicateFileNames'?: boolean;
+}
+

package/models/tus-upload-info.ts

@@ -0,0 +1,24 @@
+/* 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 interface TusUploadInfo {
+    'uploadId'?: string;
+    'offset'?: number;
+    'length'?: number;
+    'expiresAt'?: string;
+    'uploadUrl'?: string;
+}
+

package/models/update-comment-request.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.
+ */
+
+
+
+export interface UpdateCommentRequest {
+    /**
+     * The updated comment message content (HTML allowed)
+     */
+    'message': string;
+    /**
+     * Updated user IDs mentioned in the comment via @mentions
+     */
+    'mentionedUserIds'?: Set<string>;
+}
+

package/models/update-metadata-audit.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AuditLogDetails } from './audit-log-details';
+
+/**
+ * @type UpdateMetadataAudit
+ * type=updateMetadata
+ */
+export type UpdateMetadataAudit = AuditLogDetails;
+
+

package/models/update-metadata-request.ts

@@ -0,0 +1,23 @@
+/* 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 interface UpdateMetadataRequest {
+    /**
+     * Metadata key-value pairs to update or add.
+     */
+    'metadataToUpdate': { [key: string]: any; };
+}
+

package/models/update-team-request.ts

@@ -0,0 +1,21 @@
+/* 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 interface UpdateTeamRequest {
+    'name': string;
+    'email': string;
+}
+