@openfilz-sdk/typescript-ee 1.3.5

package/docs/TusFinalizeRequest.md

@@ -0,0 +1,26 @@
+# TusFinalizeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **string** |  | [default to undefined]
+**parentFolderId** | **string** |  | [optional] [default to undefined]
+**metadata** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**allowDuplicateFileNames** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TusFinalizeRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: TusFinalizeRequest = {
+    filename,
+    parentFolderId,
+    metadata,
+    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/TusUploadInfo.md

@@ -0,0 +1,28 @@
+# TusUploadInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uploadId** | **string** |  | [optional] [default to undefined]
+**offset** | **number** |  | [optional] [default to undefined]
+**length** | **number** |  | [optional] [default to undefined]
+**expiresAt** | **string** |  | [optional] [default to undefined]
+**uploadUrl** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TusUploadInfo } from '@openfilz-sdk/typescript-ee';
+
+const instance: TusUploadInfo = {
+    uploadId,
+    offset,
+    length,
+    expiresAt,
+    uploadUrl,
+};
+```
+
+[[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/UpdateCommentRequest.md

@@ -0,0 +1,22 @@
+# UpdateCommentRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | The updated comment message content (HTML allowed) | [default to undefined]
+**mentionedUserIds** | **Set<string>** | Updated user IDs mentioned in the comment via @mentions | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCommentRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: UpdateCommentRequest = {
+    message,
+    mentionedUserIds,
+};
+```
+
+[[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/UpdateMetadataAudit.md

@@ -0,0 +1,21 @@
+# UpdateMetadataAudit
+
+type=updateMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**updatedMetadata** | **{ [key: string]: any; }** | Updated Metadata | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateMetadataAudit } from '@openfilz-sdk/typescript-ee';
+
+const instance: UpdateMetadataAudit = {
+    updatedMetadata,
+};
+```
+
+[[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/UpdateMetadataRequest.md

@@ -0,0 +1,20 @@
+# UpdateMetadataRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadataToUpdate** | **{ [key: string]: any; }** | Metadata key-value pairs to update or add. | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateMetadataRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: UpdateMetadataRequest = {
+    metadataToUpdate,
+};
+```
+
+[[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/UpdateTeamRequest.md

@@ -0,0 +1,22 @@
+# UpdateTeamRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateTeamRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: UpdateTeamRequest = {
+    name,
+    email,
+};
+```
+
+[[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/UpdateUserRequest.md

@@ -0,0 +1,24 @@
+# UpdateUserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateUserRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: UpdateUserRequest = {
+    name,
+    email,
+    status,
+};
+```
+
+[[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/UploadAudit.md

@@ -0,0 +1,25 @@
+# UploadAudit
+
+type=upload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **string** |  | [optional] [default to undefined]
+**parentFolderId** | **string** |  | [optional] [default to undefined]
+**metadata** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UploadAudit } from '@openfilz-sdk/typescript-ee';
+
+const instance: UploadAudit = {
+    filename,
+    parentFolderId,
+    metadata,
+};
+```
+
+[[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/UploadResponse.md

@@ -0,0 +1,30 @@
+# UploadResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**contentType** | **string** |  | [optional] [default to undefined]
+**size** | **number** |  | [optional] [default to undefined]
+**errorType** | **string** |  | [optional] [default to undefined]
+**errorMessage** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UploadResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: UploadResponse = {
+    id,
+    name,
+    contentType,
+    size,
+    errorType,
+    errorMessage,
+};
+```
+
+[[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/UserPreferencesRequest.md

@@ -0,0 +1,22 @@
+# UserPreferencesRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**language** | **string** |  | [optional] [default to undefined]
+**theme** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserPreferencesRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: UserPreferencesRequest = {
+    language,
+    theme,
+};
+```
+
+[[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/UserRegistrationRequest.md

@@ -0,0 +1,24 @@
+# UserRegistrationRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UserRegistrationRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: UserRegistrationRequest = {
+    name,
+    email,
+    status,
+};
+```
+
+[[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/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="openfilz"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="openfilz-ee"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/graphql/analytics.graphqls

@@ -0,0 +1,101 @@
+extend type Query {
+    # System Overview
+    analyticsSystemOverview: SystemOverview
+    # Document Analytics
+    analyticsUploadTrends(from: DateTime!, to: DateTime!, granularity: String!): [TimeSeriesPoint]
+    analyticsDocumentTypeDistribution: [ContentTypeDistribution]
+    analyticsStorageOverTime(from: DateTime!, to: DateTime!, granularity: String!): [TimeSeriesPoint]
+    analyticsMostActiveDocuments(limit: Int!): [DocumentActivityDetail]
+    # User Activity
+    analyticsMostActiveUsers(limit: Int!): [UserActivityDetail]
+    analyticsUserActivityTimeline(from: DateTime!, to: DateTime!, granularity: String!): [TimeSeriesPoint]
+    analyticsActivityHeatmap(from: DateTime!, to: DateTime!): [ActivityHeatmapPoint]
+    # Sharing Analytics
+    analyticsMostSharedDocuments(limit: Int!): [SharedDocumentInfo]
+    analyticsShareModeDistribution: [ShareModeDistribution]
+    analyticsShareRequestStats: ShareRequestStats
+    # Audit Trail
+    analyticsActivityByActionType(from: DateTime!, to: DateTime!): [ActionTypeCount]
+    analyticsAuditEvents(from: DateTime!, to: DateTime!, limit: Int!, offset: Int!): [AuditEventInfo]
+    analyticsAuditEventsByDocument(docId: UUID!): [AuditEventInfo]
+    analyticsAuditEventsByUser(userEmail: String!, from: DateTime!, to: DateTime!): [AuditEventInfo]
+}
+
+type SystemOverview {
+    activeUsers: Long
+    totalDocuments: Long
+    totalFolders: Long
+    totalStorageBytes: Long
+}
+
+type TimeSeriesPoint {
+    period: DateTime
+    value: Long
+}
+
+type ContentTypeDistribution {
+    contentType: String
+    count: Long
+    totalSize: Long
+}
+
+type DocumentActivityDetail {
+    id: UUID
+    name: String
+    contentType: String
+    docType: String
+    ownerEmail: String
+    actionCount: Long
+    lastActivity: DateTime
+}
+
+type UserActivityDetail {
+    email: String
+    name: String
+    uploads: Long
+    downloads: Long
+    deletes: Long
+    shares: Long
+    totalActions: Long
+}
+
+type ActivityHeatmapPoint {
+    dayOfWeek: Int
+    hourOfDay: Int
+    count: Long
+}
+
+type SharedDocumentInfo {
+    id: UUID
+    name: String
+    contentType: String
+    docType: String
+    shareCount: Long
+}
+
+type ShareModeDistribution {
+    shareMode: String
+    count: Long
+}
+
+type ShareRequestStats {
+    totalShares: Long
+    readerShares: Long
+    commenterShares: Long
+    editorShares: Long
+}
+
+type ActionTypeCount {
+    action: String
+    count: Long
+}
+
+type AuditEventInfo {
+    id: Long
+    timestamp: DateTime
+    userPrincipal: String
+    action: String
+    resourceType: String
+    resourceId: UUID
+    documentName: String
+}

package/graphql/comment.graphqls

@@ -0,0 +1,33 @@
+extend type Query {
+    """
+    List comments for a document with optional filters.
+    """
+    listComments(filter: CommentRequest!): [Comment]
+}
+
+"""
+Input filter for listing comments
+"""
+input CommentRequest {
+    "Document ID to get comments for (required)"
+    docId: UUID!
+    "Optional filter by comment creator"
+    createdUserId: UUID
+    "Optional filter by mentioned users"
+    mentionedUserIds: [UUID!]
+}
+
+"""
+Comment with user information
+"""
+type Comment {
+    id: UUID!
+    docIds: [UUID!]!
+    message: String!
+    createdUserId: UUID!
+    createdUserEmail: String
+    createdUserName: String
+    createdAt: DateTime!
+    updatedAt: DateTime
+    mentionedUserIds: [UUID!]
+}

package/graphql/document-search.graphqls

@@ -0,0 +1,44 @@
+# The document type returned by the search
+type DocumentSearchInfo {
+    id: ID!
+    name: String!
+    extension: String
+    contentType: String
+    size: Long
+    parentId: ID
+    createdAt: DateTime
+    updatedAt: DateTime
+    createdBy: String
+    updatedBy: String
+    contentSnippet: String # return a snippet instead of the full content
+    "URL to fetch the thumbnail image, null if not available"
+    thumbnailUrl: String
+}
+
+# The response object containing results and pagination info
+type DocumentSearchResult {
+    totalHits: Int!
+    documents: [DocumentSearchInfo!]!
+}
+
+# Input for filtering
+input FilterInput {
+    field: String!
+    value: String!
+}
+
+# Input for sorting
+input SortInput {
+    field: String!
+    order: SortOrder = DESC
+}
+
+extend type Query {
+    searchDocuments(
+        query: String,
+        filters: [FilterInput!],
+        sort: SortInput,
+        page: Int = 0,
+        size: Int = 20
+    ): DocumentSearchResult
+}

package/graphql/document.graphqls

@@ -0,0 +1,116 @@
+scalar JSON
+scalar Long
+scalar DateTime
+@specifiedBy(url: "https://scalars.graphql.org/andimarek/date-time.html")
+scalar UUID
+@specifiedBy(url:"https://tools.ietf.org/html/rfc4122")
+
+type Query {
+    listFolder(request: ListFolderRequest!): [FolderElementInfo]
+    "List documents across all folders (ignores parent folder filter)"
+    listAllFolder(request: ListFolderRequest!): [FolderElementInfo]
+    documentById(id: UUID!): DocumentInfo
+    count(request: ListFolderRequest): Long
+    listFavorites(request: FavoriteRequest!): [FolderElementInfo]
+    countFavorites(request: FavoriteRequest): Long
+}
+
+type FolderElementInfo {
+    id : UUID
+    type : DocumentType
+    contentType : String
+    name : String
+    metadata : JSON
+    size : Long
+    createdAt : DateTime
+    updatedAt : DateTime
+    createdBy : String
+    updatedBy : String
+    favorite : Boolean
+    "URL to fetch the thumbnail image, null if not available"
+    thumbnailUrl : String
+}
+
+type DocumentInfo {
+    id : UUID
+    parentId : UUID
+    type : DocumentType
+    contentType : String
+    name : String
+    metadata : JSON
+    size : Long
+    createdAt : DateTime
+    updatedAt : DateTime
+    createdBy : String
+    updatedBy : String
+    "URL to fetch the thumbnail image, null if not available"
+    thumbnailUrl : String
+}
+
+"""
+Filter Object used to list or count the content of a given folder
+"""
+input ListFolderRequest {
+    "Id of the folder"
+    id : UUID
+    "Type (FILE or FOLDER) of the elements to filter"
+    type : DocumentType
+    "Content-Type of the files to filter"
+    contentType : String
+    "name of the elements to filter (exact match)"
+    name : String
+    "name of the elements to filter (like clause)"
+    nameLike : String
+    "metadata of the elements to filter (contains clause)"
+    metadata : JSON
+    size : Long
+    createdAtAfter : DateTime
+    createdAtBefore : DateTime
+    updatedAtAfter : DateTime
+    updatedAtBefore : DateTime
+    createdBy : String
+    updatedBy : String
+    pageInfo : PageInfo
+    favorite : Boolean
+    active : Boolean = true
+    "When true and id is set, search recursively in all subfolders of the given folder"
+    recursive : Boolean
+}
+
+input FavoriteRequest {
+    "Type (FILE or FOLDER) of the elements to filter"
+    type : DocumentType
+    "Content-Type of the files to filter"
+    contentType : String
+    "name of the elements to filter (exact match)"
+    name : String
+    "name of the elements to filter (like clause)"
+    nameLike : String
+    "metadata of the elements to filter (contains clause)"
+    metadata : JSON
+    size : Long
+    createdAtAfter : DateTime
+    createdAtBefore : DateTime
+    updatedAtAfter : DateTime
+    updatedAtBefore : DateTime
+    createdBy : String
+    updatedBy : String
+    pageInfo : PageInfo
+}
+
+
+
+input PageInfo {
+    pageNumber : Int!
+    pageSize : Int!
+    sortBy : String
+    sortOrder : SortOrder
+}
+
+enum SortOrder {
+    ASC, DESC
+}
+
+enum DocumentType {
+    FILE, FOLDER
+}