@openfilz-sdk/typescript 1.1.5-SNAPSHOT → 1.1.7

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';
+
+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';
+
+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/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';
+
+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';
+
+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/graphql/document-search.graphqls

@@ -1,44 +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
-}
+# 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

@@ -1,114 +1,114 @@
-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
-}
-
-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
-}
+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
+}
+
+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
+}

package/models/ancestor-info.ts

@@ -14,29 +14,9 @@
 
 
 
-/**
- * 
- * @export
- * @interface AncestorInfo
- */
 export interface AncestorInfo {
-    /**
-     * 
-     * @type {string}
-     * @memberof AncestorInfo
-     */
     'id'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AncestorInfo
-     */
     'name'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AncestorInfo
-     */
     'type'?: string;
 }
 

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

@@ -13,36 +13,40 @@
  */
 
 
+// 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';
+// 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=copy
- * @export
- * @interface AuditLogDetailsOneOf
+ * @type AuditLogDetailsOneOf
  */
-export interface AuditLogDetailsOneOf {
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLogDetailsOneOf
-     */
-    'type': string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLogDetailsOneOf
-     */
-    'sourceFileId'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLogDetailsOneOf
-     */
-    'targetFolderId'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLogDetailsOneOf
-     */
-    'sourceFolderId'?: string;
-}
+export type AuditLogDetailsOneOf = { type: 'CopyAudit' } & CopyAudit | { type: 'CreateFolderAudit' } & CreateFolderAudit | { type: 'DeleteAudit' } & DeleteAudit | { type: 'DeleteMetadataAudit' } & DeleteMetadataAudit | { type: 'MoveAudit' } & MoveAudit | { type: 'RenameAudit' } & RenameAudit | { type: 'ReplaceAudit' } & ReplaceAudit | { type: 'UpdateMetadataAudit' } & UpdateMetadataAudit | { type: 'UploadAudit' } & UploadAudit;
+
 

package/models/audit-log-details.ts

@@ -13,41 +13,8 @@
  */
 
 
-// May contain unused imports in some cases
-// @ts-ignore
-import type { AuditLogDetailsOneOf } from './audit-log-details-one-of';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { AuditLogDetailsOneOf1 } from './audit-log-details-one-of1';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { AuditLogDetailsOneOf2 } from './audit-log-details-one-of2';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { AuditLogDetailsOneOf3 } from './audit-log-details-one-of3';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { AuditLogDetailsOneOf4 } from './audit-log-details-one-of4';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { AuditLogDetailsOneOf5 } from './audit-log-details-one-of5';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { AuditLogDetailsOneOf6 } from './audit-log-details-one-of6';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { AuditLogDetailsOneOf7 } from './audit-log-details-one-of7';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { AuditLogDetailsOneOf8 } from './audit-log-details-one-of8';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { CreateFolderRequest } from './create-folder-request';
-
-/**
- * @type AuditLogDetails
- * @export
- */
-export type AuditLogDetails = AuditLogDetailsOneOf | AuditLogDetailsOneOf1 | AuditLogDetailsOneOf2 | AuditLogDetailsOneOf3 | AuditLogDetailsOneOf4 | AuditLogDetailsOneOf5 | AuditLogDetailsOneOf6 | AuditLogDetailsOneOf7 | AuditLogDetailsOneOf8;
 
+export interface AuditLogDetails {
+    'type': string;
+}
 

package/models/audit-log.ts

@@ -15,61 +15,19 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { AuditLogDetails } from './audit-log-details';
+import type { AuditLogDetailsOneOf } from './audit-log-details-one-of';
 
 /**
  * Audit information
- * @export
- * @interface AuditLog
  */
 export interface AuditLog {
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLog
-     */
     'id'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLog
-     */
     'timestamp'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLog
-     */
     'username'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLog
-     */
     'action'?: AuditLogActionEnum;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLog
-     */
     'resourceType'?: AuditLogResourceTypeEnum;
-    /**
-     * 
-     * @type {AuditLogDetails}
-     * @memberof AuditLog
-     */
-    'details'?: AuditLogDetails;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLog
-     */
+    'details'?: AuditLogDetailsOneOf;
     'previousHash'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditLog
-     */
     'hash'?: string;
 }
 

package/models/audit-verification-result.ts

@@ -15,44 +15,17 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { AuditVerificationResultBrokenLink } from './audit-verification-result-broken-link';
+import type { BrokenLink } from './broken-link';
 
 /**
  * Result of audit chain integrity verification
- * @export
- * @interface AuditVerificationResult
  */
 export interface AuditVerificationResult {
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditVerificationResult
-     */
     'status'?: AuditVerificationResultStatusEnum;
-    /**
-     * 
-     * @type {number}
-     * @memberof AuditVerificationResult
-     */
     'totalEntries'?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof AuditVerificationResult
-     */
     'verifiedEntries'?: number;
-    /**
-     * 
-     * @type {string}
-     * @memberof AuditVerificationResult
-     */
     'verifiedAt'?: string;
-    /**
-     * 
-     * @type {AuditVerificationResultBrokenLink}
-     * @memberof AuditVerificationResult
-     */
-    'brokenLink'?: AuditVerificationResultBrokenLink;
+    'brokenLink'?: BrokenLink;
 }
 
 export const AuditVerificationResultStatusEnum = {