@openfilz-sdk/typescript-ee 1.10.4 → 1.10.5

package/dist/esm/api/desktop-sync-administration-api.js

@@ -0,0 +1,180 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
+/**
+ * DesktopSyncAdministrationApi - axios parameter creator
+ */
+export const DesktopSyncAdministrationApiAxiosParamCreator = function (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: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            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 = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, 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: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * DesktopSyncAdministrationApi - functional programming interface
+ */
+export const DesktopSyncAdministrationApiFp = function (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}
+         */
+        start1(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.start1(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DesktopSyncAdministrationApi.start1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.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}
+         */
+        status(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.status(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DesktopSyncAdministrationApi.status']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * DesktopSyncAdministrationApi - factory interface
+ */
+export const DesktopSyncAdministrationApiFactory = function (configuration, basePath, axios) {
+    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) {
+            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) {
+            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}
+     */
+    start1(options) {
+        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}
+     */
+    status(options) {
+        return DesktopSyncAdministrationApiFp(this.configuration).status(options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/api/desktop-sync-api.d.ts

@@ -0,0 +1,282 @@
+/**
+ * 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 { type RequestArgs, BaseAPI } from '../base';
+import type { DesktopSyncClientInfo } from '../models';
+import type { SyncChangesResponse } from '../models';
+import type { SyncItem } from '../models';
+import type { SyncSnapshotResponse } from '../models';
+/**
+ * DesktopSyncApi - axios parameter creator
+ */
+export declare const DesktopSyncApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Without a cursor: no items, only the cursor of the present moment. An item is either the document\'s current state or {gone: true}. Call again while hasMore is true.
+     * @summary Documents that changed since a cursor, as the caller sees them now
+     * @param {number} [cursor]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changes: (cursor?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * If-None-Match with the hash the client already holds answers 304 without a body.
+     * @summary Download a file; its ETag is the SHA-256 of the content
+     * @param {string} documentId
+     * @param {string} [ifNoneMatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    content: (documentId: string, ifNoneMatch?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Connection details for the desktop application (public)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    discover: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Where to get the desktop application, and the address to give it
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forWebApplication: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * What /changes would answer for these ids: a client asks after its own upload, or to settle a conflict. Ids the caller cannot see come back as {gone: true}. At most 200 ids.
+     * @summary Current state of the given documents, as the caller sees them
+     * @param {Array<string>} ids
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    items: (ids: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * If-Match carries the SHA-256 the client last saw. 412 = the content changed on the server in the meantime: keep both. 428 = no If-Match. Answers the document\'s new state.
+     * @summary Replace a file\'s content, only if it is still the content the edit was based on
+     * @param {string} documentId
+     * @param {File} file
+     * @param {string} [ifMatch]
+     * @param {number} [contentLength]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceContent: (documentId: string, file: File, ifMatch?: string, contentLength?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * The root holds the caller\'s own top-level items and the entry point of everything shared with them. Keep the cursor of the first page and start /changes from it.
+     * @summary One page of a folder\'s children; without folderId, the caller\'s root
+     * @param {string} [folderId]
+     * @param {string} [after]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    snapshot: (folderId?: string, after?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DesktopSyncApi - functional programming interface
+ */
+export declare const DesktopSyncApiFp: (configuration?: Configuration) => {
+    /**
+     * Without a cursor: no items, only the cursor of the present moment. An item is either the document\'s current state or {gone: true}. Call again while hasMore is true.
+     * @summary Documents that changed since a cursor, as the caller sees them now
+     * @param {number} [cursor]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changes(cursor?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncChangesResponse>>;
+    /**
+     * If-None-Match with the hash the client already holds answers 304 without a body.
+     * @summary Download a file; its ETag is the SHA-256 of the content
+     * @param {string} documentId
+     * @param {string} [ifNoneMatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    content(documentId: string, ifNoneMatch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     *
+     * @summary Connection details for the desktop application (public)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    discover(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DesktopSyncClientInfo>>;
+    /**
+     *
+     * @summary Where to get the desktop application, and the address to give it
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forWebApplication(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DesktopSyncClientInfo>>;
+    /**
+     * What /changes would answer for these ids: a client asks after its own upload, or to settle a conflict. Ids the caller cannot see come back as {gone: true}. At most 200 ids.
+     * @summary Current state of the given documents, as the caller sees them
+     * @param {Array<string>} ids
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    items(ids: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SyncItem>>>;
+    /**
+     * If-Match carries the SHA-256 the client last saw. 412 = the content changed on the server in the meantime: keep both. 428 = no If-Match. Answers the document\'s new state.
+     * @summary Replace a file\'s content, only if it is still the content the edit was based on
+     * @param {string} documentId
+     * @param {File} file
+     * @param {string} [ifMatch]
+     * @param {number} [contentLength]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceContent(documentId: string, file: File, ifMatch?: string, contentLength?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncItem>>;
+    /**
+     * The root holds the caller\'s own top-level items and the entry point of everything shared with them. Keep the cursor of the first page and start /changes from it.
+     * @summary One page of a folder\'s children; without folderId, the caller\'s root
+     * @param {string} [folderId]
+     * @param {string} [after]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    snapshot(folderId?: string, after?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncSnapshotResponse>>;
+};
+/**
+ * DesktopSyncApi - factory interface
+ */
+export declare const DesktopSyncApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Without a cursor: no items, only the cursor of the present moment. An item is either the document\'s current state or {gone: true}. Call again while hasMore is true.
+     * @summary Documents that changed since a cursor, as the caller sees them now
+     * @param {number} [cursor]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changes(cursor?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<SyncChangesResponse>;
+    /**
+     * If-None-Match with the hash the client already holds answers 304 without a body.
+     * @summary Download a file; its ETag is the SHA-256 of the content
+     * @param {string} documentId
+     * @param {string} [ifNoneMatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    content(documentId: string, ifNoneMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     *
+     * @summary Connection details for the desktop application (public)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    discover(options?: RawAxiosRequestConfig): AxiosPromise<DesktopSyncClientInfo>;
+    /**
+     *
+     * @summary Where to get the desktop application, and the address to give it
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forWebApplication(options?: RawAxiosRequestConfig): AxiosPromise<DesktopSyncClientInfo>;
+    /**
+     * What /changes would answer for these ids: a client asks after its own upload, or to settle a conflict. Ids the caller cannot see come back as {gone: true}. At most 200 ids.
+     * @summary Current state of the given documents, as the caller sees them
+     * @param {Array<string>} ids
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    items(ids: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<SyncItem>>;
+    /**
+     * If-Match carries the SHA-256 the client last saw. 412 = the content changed on the server in the meantime: keep both. 428 = no If-Match. Answers the document\'s new state.
+     * @summary Replace a file\'s content, only if it is still the content the edit was based on
+     * @param {string} documentId
+     * @param {File} file
+     * @param {string} [ifMatch]
+     * @param {number} [contentLength]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceContent(documentId: string, file: File, ifMatch?: string, contentLength?: number, options?: RawAxiosRequestConfig): AxiosPromise<SyncItem>;
+    /**
+     * The root holds the caller\'s own top-level items and the entry point of everything shared with them. Keep the cursor of the first page and start /changes from it.
+     * @summary One page of a folder\'s children; without folderId, the caller\'s root
+     * @param {string} [folderId]
+     * @param {string} [after]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    snapshot(folderId?: string, after?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<SyncSnapshotResponse>;
+};
+/**
+ * DesktopSyncApi - object-oriented interface
+ */
+export declare class DesktopSyncApi extends BaseAPI {
+    /**
+     * Without a cursor: no items, only the cursor of the present moment. An item is either the document\'s current state or {gone: true}. Call again while hasMore is true.
+     * @summary Documents that changed since a cursor, as the caller sees them now
+     * @param {number} [cursor]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changes(cursor?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncChangesResponse, any, {}, any>>;
+    /**
+     * If-None-Match with the hash the client already holds answers 304 without a body.
+     * @summary Download a file; its ETag is the SHA-256 of the content
+     * @param {string} documentId
+     * @param {string} [ifNoneMatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    content(documentId: string, ifNoneMatch?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}, any>>;
+    /**
+     *
+     * @summary Connection details for the desktop application (public)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    discover(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DesktopSyncClientInfo, any, {}, any>>;
+    /**
+     *
+     * @summary Where to get the desktop application, and the address to give it
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forWebApplication(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DesktopSyncClientInfo, any, {}, any>>;
+    /**
+     * What /changes would answer for these ids: a client asks after its own upload, or to settle a conflict. Ids the caller cannot see come back as {gone: true}. At most 200 ids.
+     * @summary Current state of the given documents, as the caller sees them
+     * @param {Array<string>} ids
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    items(ids: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncItem[], any, {}, any>>;
+    /**
+     * If-Match carries the SHA-256 the client last saw. 412 = the content changed on the server in the meantime: keep both. 428 = no If-Match. Answers the document\'s new state.
+     * @summary Replace a file\'s content, only if it is still the content the edit was based on
+     * @param {string} documentId
+     * @param {File} file
+     * @param {string} [ifMatch]
+     * @param {number} [contentLength]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceContent(documentId: string, file: File, ifMatch?: string, contentLength?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncItem, any, {}, any>>;
+    /**
+     * The root holds the caller\'s own top-level items and the entry point of everything shared with them. Keep the cursor of the first page and start /changes from it.
+     * @summary One page of a folder\'s children; without folderId, the caller\'s root
+     * @param {string} [folderId]
+     * @param {string} [after]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    snapshot(folderId?: string, after?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncSnapshotResponse, any, {}, any>>;
+}