@openfilz-sdk/typescript-ee 1.10.4 → 1.10.6

package/dist/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>>;
+}