@openfilz-sdk/typescript-ee 1.3.5

package/graphql/share.graphqls

@@ -0,0 +1,168 @@
+extend type Query {
+    listOwned(request: ListFolderRequest!): [FolderElementInfo]
+    countOwned(request: ListFolderRequest): Long
+    listSharedWithMe(request: ListFolderRequest!): [FolderElementInfo]
+    countSharedWithMe(request: ListFolderRequest): Long
+    listSharedByMe(request: ListFolderRequest!, sharedWithUserId: UUID): [FolderElementInfo]
+    countSharedByMe(request: ListFolderRequest, sharedWithUserId: UUID): Long
+    listDocShares(docId: UUID!): [SharedWith]
+    "Lists the teams the connected user belongs to"
+    listMyTeams: [TeamInfo!]!
+    """
+    Lists all users in the connected user's organization.
+    Access restricted to LICENSED users only.
+    """
+    listOrganizationUsers(request: ListOrganizationUsersRequest!): OrganizationUsersResult
+    """
+    Lists pending share requests for the connected user (as document owner).
+    Accessible only by users with EDIT_SHARE role.
+    """
+    listShareRequests(request: ListShareRequestsInput!): ShareRequestsResult
+    """
+    Counts pending share requests for the connected user (as document owner).
+    Accessible only by users with EDIT_SHARE role.
+    """
+    countShareRequests: Long
+}
+
+extend input ListFolderRequest {
+    "Whether this document is shared with the current user in editor mode"
+    sharedEdit : Boolean
+    "Whether this document is shared with the current user in commenter mode"
+    sharedComment : Boolean
+    "Whether this document is the top level element shared by a user with the current user"
+    rootShare : Boolean
+}
+
+extend type DocumentInfo {
+    "Whether this document is shared with the current user in editor mode"
+    sharedEdit : Boolean
+    "Whether this document is shared with the current user in commenter mode"
+    sharedComment : Boolean
+    "Whether this document is the top level element shared by a user with the current user"
+    rootShare : Boolean
+    "The team ID through which this document is shared with the current user, null if shared directly"
+    sharedTeamId : UUID
+}
+
+extend type FolderElementInfo {
+    "Whether this document is shared with the current user in editor mode"
+    sharedEdit : Boolean
+    "Whether this document is shared with the current user in commenter mode"
+    sharedComment : Boolean
+    "Whether this document is the top level element shared by a user with the current user"
+    rootShare : Boolean
+    "The team ID through which this document is shared with the current user, null if shared directly"
+    sharedTeamId : UUID
+}
+
+type SharedWith {
+    userId : UUID
+    email: String
+    mode : ShareMode
+    status: UserStatusEnum
+    rootOwner: Boolean
+    type: UserTypeEnum
+}
+
+enum ShareMode {
+    READER, COMMENTER, EDITOR
+}
+
+"""
+Request input for listing organization users
+"""
+input ListOrganizationUsersRequest {
+    "Filter by email (exact match)"
+    email: String
+    "Filter by email (like clause)"
+    emailLike: String
+    "Filter by name (exact match)"
+    name: String
+    "Filter by name (like clause)"
+    nameLike: String
+    "Filter by user type"
+    type: UserTypeEnum
+    "Filter by user status"
+    status: UserStatusEnum
+    "Include the connected user in the results (default: false, which excludes self)"
+    includeSelf: Boolean
+    "Paging information (required)"
+    pageInfo: PageInfo!
+}
+
+"""
+User information returned in organization user list
+"""
+type OrganizationUserInfo {
+    id: UUID!
+    email: String!
+    name: String
+    type: UserTypeEnum!
+    status: UserStatusEnum!
+    "Whether the email can be changed (false if user has verified email or logged in)"
+    emailEditable: Boolean
+}
+
+"""
+Result wrapper for organization users list with total count
+"""
+type OrganizationUsersResult {
+    users: [OrganizationUserInfo!]!
+    totalCount: Long!
+}
+
+"""
+User type enumeration
+"""
+enum UserTypeEnum {
+    USER, TEAM, ORGANIZATION
+}
+
+"""
+User status enumeration
+"""
+enum UserStatusEnum {
+    FREE, LICENSED, DEACTIVATED
+}
+
+"""
+Input for listing share requests
+"""
+input ListShareRequestsInput {
+    pageInfo: PageInfo!
+}
+
+"""
+Information about a pending share request
+"""
+type ShareRequestInfo {
+    id: UUID!
+    requesterId: UUID!
+    requesterName: String
+    requesterEmail: String
+    docId: UUID!
+    documentName: String
+    sharedUserId: UUID!
+    sharedUserName: String
+    sharedUserEmail: String
+    shareMode: ShareMode!
+    createdAt: DateTime!
+}
+
+"""
+Result wrapper for share requests list with total count
+"""
+type ShareRequestsResult {
+    requests: [ShareRequestInfo!]!
+    totalCount: Long!
+}
+
+"""
+Information about a team the user belongs to
+"""
+type TeamInfo {
+    id: UUID!
+    name: String
+    email: String!
+}

package/index.ts

@@ -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 * from "./api";
+export * from "./configuration";
+export * from "./models";

package/models/ancestor-info.ts

@@ -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 interface AncestorInfo {
+    'id'?: string;
+    'name'?: string;
+    'type'?: string;
+}
+

package/models/audit-log-details-one-of.ts

@@ -0,0 +1,70 @@
+/* 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 { CopyAudit } from './copy-audit';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { CreateFolderAudit } from './create-folder-audit';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { CreateFolderRequest } from './create-folder-request';
+// @ts-ignore
+import type { CopyAudit } from './copy-audit';
+// @ts-ignore
+import type { CreateFolderAudit } from './create-folder-audit';
+// @ts-ignore
+import type { DeleteAudit } from './delete-audit';
+// @ts-ignore
+import type { DeleteMetadataAudit } from './delete-metadata-audit';
+// @ts-ignore
+import type { MoveAudit } from './move-audit';
+// @ts-ignore
+import type { RenameAudit } from './rename-audit';
+// @ts-ignore
+import type { ReplaceAudit } from './replace-audit';
+// @ts-ignore
+import type { UpdateMetadataAudit } from './update-metadata-audit';
+// @ts-ignore
+import type { UploadAudit } from './upload-audit';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DeleteAudit } from './delete-audit';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DeleteMetadataAudit } from './delete-metadata-audit';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MoveAudit } from './move-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
+import type { ReplaceAudit } from './replace-audit';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { UpdateMetadataAudit } from './update-metadata-audit';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { UploadAudit } from './upload-audit';
+
+/**
+ * @type AuditLogDetailsOneOf
+ */
+export type AuditLogDetailsOneOf = { type: 'copy' } & CopyAudit | { type: 'createFolder' } & CreateFolderAudit | { type: 'delete' } & DeleteAudit | { type: 'deleteMetadata' } & DeleteMetadataAudit | { type: 'move' } & MoveAudit | { type: 'rename' } & RenameAudit | { type: 'replace' } & ReplaceAudit | { type: 'updateMetadata' } & UpdateMetadataAudit | { type: 'upload' } & UploadAudit;
+
+

package/models/audit-log-details.ts

@@ -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 interface AuditLogDetails {
+    'type': string;
+}
+

package/models/audit-log.ts

@@ -0,0 +1,75 @@
+/* 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 { AuditLogDetailsOneOf } from './audit-log-details-one-of';
+
+/**
+ * Audit information
+ */
+export interface AuditLog {
+    'id'?: string;
+    'timestamp'?: string;
+    'username'?: string;
+    'action'?: AuditLogActionEnum;
+    'resourceType'?: AuditLogResourceTypeEnum;
+    'details'?: AuditLogDetailsOneOf;
+    'previousHash'?: string;
+    'hash'?: string;
+}
+
+export const AuditLogActionEnum = {
+    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 AuditLogActionEnum = typeof AuditLogActionEnum[keyof typeof AuditLogActionEnum];
+export const AuditLogResourceTypeEnum = {
+    File: 'FILE',
+    Folder: 'FOLDER'
+} as const;
+
+export type AuditLogResourceTypeEnum = typeof AuditLogResourceTypeEnum[keyof typeof AuditLogResourceTypeEnum];
+
+

package/models/audit-verification-result.ts

@@ -0,0 +1,39 @@
+/* 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 { BrokenLink } from './broken-link';
+
+/**
+ * Result of audit chain integrity verification
+ */
+export interface AuditVerificationResult {
+    'status'?: AuditVerificationResultStatusEnum;
+    'totalEntries'?: number;
+    'verifiedEntries'?: number;
+    'verifiedAt'?: string;
+    'brokenLink'?: BrokenLink;
+}
+
+export const AuditVerificationResultStatusEnum = {
+    Valid: 'VALID',
+    Broken: 'BROKEN',
+    Empty: 'EMPTY'
+} as const;
+
+export type AuditVerificationResultStatusEnum = typeof AuditVerificationResultStatusEnum[keyof typeof AuditVerificationResultStatusEnum];
+
+

package/models/broken-link.ts

@@ -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 interface BrokenLink {
+    'entryId'?: number;
+    'expectedHash'?: string;
+    'actualHash'?: string;
+}
+

package/models/comment-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 CommentDTO {
+    'id'?: string;
+    'docIds'?: Set<string>;
+    'message'?: string;
+    'createdUserId'?: string;
+    'createdUserEmail'?: string;
+    'createdUserName'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+    'mentionedUserIds'?: Set<string>;
+}
+

package/models/copy-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 CopyAudit
+ * type=copy
+ */
+export type CopyAudit = AuditLogDetails;
+
+

package/models/copy-request.ts

@@ -0,0 +1,31 @@
+/* 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 CopyRequest {
+    /**
+     * List of document IDs (files or folders) to copy.
+     */
+    'documentIds'?: Array<string>;
+    /**
+     * ID of the target folder.
+     */
+    'targetFolderId'?: string;
+    /**
+     * when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
+     */
+    'allowDuplicateFileNames'?: boolean;
+}
+

package/models/copy-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.
+ */
+
+
+
+export interface CopyResponse {
+    /**
+     * Original file ID
+     */
+    'originalId'?: string;
+    /**
+     * Copied file ID
+     */
+    'copyId'?: string;
+}
+

package/models/create-blank-document-request.ts

@@ -0,0 +1,38 @@
+/* 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 CreateBlankDocumentRequest {
+    'name': string;
+    /**
+     * Type of blank document to create: WORD, EXCEL, POWERPOINT, or TEXT
+     */
+    'documentType': CreateBlankDocumentRequestDocumentTypeEnum;
+    /**
+     * ID of the parent folder. If null, created at root.
+     */
+    'parentFolderId'?: string;
+}
+
+export const CreateBlankDocumentRequestDocumentTypeEnum = {
+    Word: 'WORD',
+    Excel: 'EXCEL',
+    Powerpoint: 'POWERPOINT',
+    Text: 'TEXT'
+} as const;
+
+export type CreateBlankDocumentRequestDocumentTypeEnum = typeof CreateBlankDocumentRequestDocumentTypeEnum[keyof typeof CreateBlankDocumentRequestDocumentTypeEnum];
+
+

package/models/create-comment-request.ts

@@ -0,0 +1,31 @@
+/* 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 CreateCommentRequest {
+    /**
+     * Document IDs to associate with this comment
+     */
+    'docIds': Set<string>;
+    /**
+     * The comment message content (HTML allowed)
+     */
+    'message': string;
+    /**
+     * User IDs mentioned in the comment via @mentions
+     */
+    'mentionedUserIds'?: Set<string>;
+}
+

package/models/create-folder-audit.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AuditLogDetails } from './audit-log-details';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { CreateFolderRequest } from './create-folder-request';
+
+/**
+ * @type CreateFolderAudit
+ * type=createFolder
+ */
+export type CreateFolderAudit = AuditLogDetails;
+
+

package/models/create-folder-request.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 CreateFolderRequest {
+    'name': string;
+    /**
+     * ID of the parent folder. If null, created at root.
+     */
+    'parentId'?: string;
+}
+