@openfilz-sdk/typescript-ee 1.10.4 → 1.10.5

package/.openapi-generator/FILES

@@ -21,6 +21,8 @@ api/comments-api.ts
 api/dashboard-api.ts
 api/delegated-browse-grants-admin-api.ts
 api/delegated-browse-grants-end-user-api.ts
+api/desktop-sync-administration-api.ts
+api/desktop-sync-api.ts
 api/document-controller-api.ts
 api/document-insights-api.ts
 api/document-suggestion-controller-api.ts
@@ -128,6 +130,9 @@ docs/DeleteMetadataAudit.md
 docs/DeleteMetadataRequest.md
 docs/DeleteRequest.md
 docs/DeleteShareRequest.md
+docs/DesktopSyncAdministrationApi.md
+docs/DesktopSyncApi.md
+docs/DesktopSyncClientInfo.md
 docs/DocumentControllerApi.md
 docs/DocumentInfo.md
 docs/DocumentInsightView.md
@@ -253,6 +258,10 @@ docs/SplitRequest.md
 docs/StartWorkflowRequest.md
 docs/StorageBreakdown.md
 docs/Suggest.md
+docs/SyncBackfillStatus.md
+docs/SyncChangesResponse.md
+docs/SyncItem.md
+docs/SyncSnapshotResponse.md
 docs/TeamInboxRequest.md
 docs/TeamInboxView.md
 docs/TeamMemberInfo.md
@@ -262,6 +271,9 @@ docs/TusControllerApi.md
 docs/TusFinalizeRequest.md
 docs/TusUploadInfo.md
 docs/Untouched.md
+docs/UnzipRequest.md
+docs/UnzipResponse.md
+docs/UnzipSkippedEntry.md
 docs/UpdateCommentRequest.md
 docs/UpdateMetadataAudit.md
 docs/UpdateMetadataRequest.md
@@ -360,6 +372,7 @@ models/delete-metadata-audit.ts
 models/delete-metadata-request.ts
 models/delete-request.ts
 models/delete-share-request.ts
+models/desktop-sync-client-info.ts
 models/document-info.ts
 models/document-insight-view.ts
 models/document-integrity-record.ts
@@ -465,6 +478,10 @@ models/split-request.ts
 models/start-workflow-request.ts
 models/storage-breakdown.ts
 models/suggest.ts
+models/sync-backfill-status.ts
+models/sync-changes-response.ts
+models/sync-item.ts
+models/sync-snapshot-response.ts
 models/team-inbox-request.ts
 models/team-inbox-view.ts
 models/team-member-info.ts
@@ -473,6 +490,9 @@ models/tus-config-response.ts
 models/tus-finalize-request.ts
 models/tus-upload-info.ts
 models/untouched.ts
+models/unzip-request.ts
+models/unzip-response.ts
+models/unzip-skipped-entry.ts
 models/update-comment-request.ts
 models/update-metadata-audit.ts
 models/update-metadata-request.ts

package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256

@@ -1 +1 @@
-aaaac9fc3a735e9dc14c9ededaed4ffbba613180cc9d256dae1a1373508a8942
+c9f45289588f38a21ebda595b05e52475deedab330696fc785210b01d60d67f0

package/README.md

@@ -1,4 +1,4 @@
-## @openfilz-sdk/typescript-ee@1.10.4
+## @openfilz-sdk/typescript-ee@1.10.5
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @openfilz-sdk/typescript-ee@1.10.4 --save
+npm install @openfilz-sdk/typescript-ee@1.10.5 --save
 ```
 
 _unPublished (not recommended):_
@@ -133,6 +133,15 @@ Class | Method | HTTP request | Description
 *DelegatedBrowseGrantsEndUserApi* | [**disableLinkedWebhook**](docs/DelegatedBrowseGrantsEndUserApi.md#disablelinkedwebhook) | **POST** /api/v1/users/me/delegated/grants/{id}/disable-webhook | Disable the webhook created from this grant
 *DelegatedBrowseGrantsEndUserApi* | [**listIncoming**](docs/DelegatedBrowseGrantsEndUserApi.md#listincoming) | **GET** /api/v1/users/me/delegated/grants | List grants addressed to me
 *DelegatedBrowseGrantsEndUserApi* | [**revoke**](docs/DelegatedBrowseGrantsEndUserApi.md#revoke) | **POST** /api/v1/users/me/delegated/grants/{id}/revoke | Revoke an accepted grant
+*DesktopSyncApi* | [**changes**](docs/DesktopSyncApi.md#changes) | **GET** /api/v1/sync/changes | Documents that changed since a cursor, as the caller sees them now
+*DesktopSyncApi* | [**content**](docs/DesktopSyncApi.md#content) | **GET** /api/v1/sync/content/{documentId} | Download a file; its ETag is the SHA-256 of the content
+*DesktopSyncApi* | [**discover**](docs/DesktopSyncApi.md#discover) | **GET** /.well-known/openfilz-desktop | Connection details for the desktop application (public)
+*DesktopSyncApi* | [**forWebApplication**](docs/DesktopSyncApi.md#forwebapplication) | **GET** /api/v1/settings/desktop-sync | Where to get the desktop application, and the address to give it
+*DesktopSyncApi* | [**items**](docs/DesktopSyncApi.md#items) | **GET** /api/v1/sync/items | Current state of the given documents, as the caller sees them
+*DesktopSyncApi* | [**replaceContent**](docs/DesktopSyncApi.md#replacecontent) | **PUT** /api/v1/sync/content/{documentId} | Replace a file\'s content, only if it is still the content the edit was based on
+*DesktopSyncApi* | [**snapshot**](docs/DesktopSyncApi.md#snapshot) | **GET** /api/v1/sync/snapshot | One page of a folder\'s children; without folderId, the caller\'s root
+*DesktopSyncAdministrationApi* | [**start1**](docs/DesktopSyncAdministrationApi.md#start1) | **POST** /api/v1/admin/sync/backfill | Run the backfill again over every file
+*DesktopSyncAdministrationApi* | [**status**](docs/DesktopSyncAdministrationApi.md#status) | **GET** /api/v1/admin/sync/backfill | Progress of the size and hash backfill
 *DocumentControllerApi* | [**createBlankDocument**](docs/DocumentControllerApi.md#createblankdocument) | **POST** /api/v1/documents/create-blank | Create a blank document from template
 *DocumentControllerApi* | [**deleteDocumentMetadata**](docs/DocumentControllerApi.md#deletedocumentmetadata) | **DELETE** /api/v1/documents/{documentId}/metadata | Delete specific metadata keys
 *DocumentControllerApi* | [**downloadDocument**](docs/DocumentControllerApi.md#downloaddocument) | **GET** /api/v1/documents/{documentId}/download | Download a document
@@ -193,6 +202,7 @@ Class | Method | HTTP request | Description
 *FileControllerApi* | [**deleteFiles**](docs/FileControllerApi.md#deletefiles) | **DELETE** /api/v1/files | Delete files
 *FileControllerApi* | [**moveFiles**](docs/FileControllerApi.md#movefiles) | **POST** /api/v1/files/move | Move files
 *FileControllerApi* | [**renameFile**](docs/FileControllerApi.md#renamefile) | **PUT** /api/v1/files/{fileId}/rename | Rename a file
+*FileControllerApi* | [**unzipFile**](docs/FileControllerApi.md#unzipfile) | **POST** /api/v1/files/{fileId}/unzip | Extract a ZIP file
 *FolderControllerApi* | [**copyFolders**](docs/FolderControllerApi.md#copyfolders) | **POST** /api/v1/folders/copy | Copy folders
 *FolderControllerApi* | [**countFolderElements**](docs/FolderControllerApi.md#countfolderelements) | **GET** /api/v1/folders/count | Count files and subfolders contained in a given folder - return 0 if empty or not exists
 *FolderControllerApi* | [**createFolder**](docs/FolderControllerApi.md#createfolder) | **POST** /api/v1/folders | Create a new folder
@@ -337,6 +347,7 @@ Class | Method | HTTP request | Description
  - [DeleteMetadataRequest](docs/DeleteMetadataRequest.md)
  - [DeleteRequest](docs/DeleteRequest.md)
  - [DeleteShareRequest](docs/DeleteShareRequest.md)
+ - [DesktopSyncClientInfo](docs/DesktopSyncClientInfo.md)
  - [DocumentInfo](docs/DocumentInfo.md)
  - [DocumentInsightView](docs/DocumentInsightView.md)
  - [DocumentIntegrityRecord](docs/DocumentIntegrityRecord.md)
@@ -441,6 +452,10 @@ Class | Method | HTTP request | Description
  - [StartWorkflowRequest](docs/StartWorkflowRequest.md)
  - [StorageBreakdown](docs/StorageBreakdown.md)
  - [Suggest](docs/Suggest.md)
+ - [SyncBackfillStatus](docs/SyncBackfillStatus.md)
+ - [SyncChangesResponse](docs/SyncChangesResponse.md)
+ - [SyncItem](docs/SyncItem.md)
+ - [SyncSnapshotResponse](docs/SyncSnapshotResponse.md)
  - [TeamInboxRequest](docs/TeamInboxRequest.md)
  - [TeamInboxView](docs/TeamInboxView.md)
  - [TeamMemberInfo](docs/TeamMemberInfo.md)
@@ -449,6 +464,9 @@ Class | Method | HTTP request | Description
  - [TusFinalizeRequest](docs/TusFinalizeRequest.md)
  - [TusUploadInfo](docs/TusUploadInfo.md)
  - [Untouched](docs/Untouched.md)
+ - [UnzipRequest](docs/UnzipRequest.md)
+ - [UnzipResponse](docs/UnzipResponse.md)
+ - [UnzipSkippedEntry](docs/UnzipSkippedEntry.md)
  - [UpdateCommentRequest](docs/UpdateCommentRequest.md)
  - [UpdateMetadataAudit](docs/UpdateMetadataAudit.md)
  - [UpdateMetadataRequest](docs/UpdateMetadataRequest.md)

package/api/desktop-sync-administration-api.ts

@@ -0,0 +1,186 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { SyncBackfillStatus } from '../models';
+/**
+ * DesktopSyncAdministrationApi - axios parameter creator
+ */
+export const DesktopSyncAdministrationApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 202 with the status once started in the background; 409 while a run is in progress.
+         * @summary Run the backfill again over every file
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        start1: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/admin/sync/backfill`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Progress of the size and hash backfill
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        status: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/admin/sync/backfill`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DesktopSyncAdministrationApi - functional programming interface
+ */
+export const DesktopSyncAdministrationApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DesktopSyncAdministrationApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 202 with the status once started in the background; 409 while a run is in progress.
+         * @summary Run the backfill again over every file
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async start1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncBackfillStatus>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.start1(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DesktopSyncAdministrationApi.start1']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Progress of the size and hash backfill
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async status(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncBackfillStatus>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.status(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DesktopSyncAdministrationApi.status']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * DesktopSyncAdministrationApi - factory interface
+ */
+export const DesktopSyncAdministrationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DesktopSyncAdministrationApiFp(configuration)
+    return {
+        /**
+         * 202 with the status once started in the background; 409 while a run is in progress.
+         * @summary Run the backfill again over every file
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        start1(options?: RawAxiosRequestConfig): AxiosPromise<SyncBackfillStatus> {
+            return localVarFp.start1(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Progress of the size and hash backfill
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        status(options?: RawAxiosRequestConfig): AxiosPromise<SyncBackfillStatus> {
+            return localVarFp.status(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DesktopSyncAdministrationApi - object-oriented interface
+ */
+export class DesktopSyncAdministrationApi extends BaseAPI {
+    /**
+     * 202 with the status once started in the background; 409 while a run is in progress.
+     * @summary Run the backfill again over every file
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public start1(options?: RawAxiosRequestConfig) {
+        return DesktopSyncAdministrationApiFp(this.configuration).start1(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Progress of the size and hash backfill
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public status(options?: RawAxiosRequestConfig) {
+        return DesktopSyncAdministrationApiFp(this.configuration).status(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+