@openfilz-sdk/typescript-ee 1.3.5 → 1.4.1

package/api/delegated-browse-grants-admin-api.ts

@@ -0,0 +1,452 @@
+/* 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 { ConsumeDelegatedGrantRequest } from '../models';
+// @ts-ignore
+import type { CreateDelegatedGrantRequest } from '../models';
+// @ts-ignore
+import type { DelegatedFolderNode } from '../models';
+// @ts-ignore
+import type { DelegatedGrantDTO } from '../models';
+/**
+ * DelegatedBrowseGrantsAdminApi - axios parameter creator
+ */
+export const DelegatedBrowseGrantsAdminApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * List folders under {parent} in the grantor\'s tree. Omit {parent} to list the grantor\'s root-level folders. Returns only name/id/hasChildren — no files, no metadata, no content-types.
+         * @summary Browse folders on behalf of the grantor
+         * @param {string} grantId 
+         * @param {string} [parent] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        browseFolders: async (grantId: string, parent?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'grantId' is not null or undefined
+            assertParamExists('browseFolders', 'grantId', grantId)
+            const localVarPath = `/api/v1/admin/delegated/folders`;
+            // 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)
+
+            if (grantId !== undefined) {
+                localVarQueryParameter['grantId'] = grantId;
+            }
+
+            if (parent !== undefined) {
+                localVarQueryParameter['parent'] = parent;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Flip an ACCEPTED grant to CONSUMED after using it to create a webhook. Single-use: subsequent browse calls return 410 Gone.
+         * @summary Mark grant as consumed
+         * @param {string} id 
+         * @param {ConsumeDelegatedGrantRequest} consumeDelegatedGrantRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        consume: async (id: string, consumeDelegatedGrantRequest: ConsumeDelegatedGrantRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('consume', 'id', id)
+            // verify required parameter 'consumeDelegatedGrantRequest' is not null or undefined
+            assertParamExists('consume', 'consumeDelegatedGrantRequest', consumeDelegatedGrantRequest)
+            const localVarPath = `/api/v1/admin/delegated/grants/{id}/consume`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // 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['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(consumeDelegatedGrantRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Admin UI polls this after creation to learn when the grantor has accepted/declined. 404 if the grant isn\'t yours.
+         * @summary Poll grant status
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGrant: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGrant', 'id', id)
+            const localVarPath = `/api/v1/admin/delegated/grants/{id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // 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'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Optionally filter by ?status=PENDING|ACCEPTED|...
+         * @summary List grants I requested
+         * @param {ListMineStatusEnum} [status] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMine: async (status?: ListMineStatusEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/admin/delegated/grants`;
+            // 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)
+
+            if (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Create a PENDING grant. Notifies the grantor via in-app + email. Grantor has 15 min to accept or the grant auto-expires.
+         * @summary Request a grant
+         * @param {CreateDelegatedGrantRequest} createDelegatedGrantRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        requestGrant: async (createDelegatedGrantRequest: CreateDelegatedGrantRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createDelegatedGrantRequest' is not null or undefined
+            assertParamExists('requestGrant', 'createDelegatedGrantRequest', createDelegatedGrantRequest)
+            const localVarPath = `/api/v1/admin/delegated/grants`;
+            // 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['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createDelegatedGrantRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DelegatedBrowseGrantsAdminApi - functional programming interface
+ */
+export const DelegatedBrowseGrantsAdminApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DelegatedBrowseGrantsAdminApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * List folders under {parent} in the grantor\'s tree. Omit {parent} to list the grantor\'s root-level folders. Returns only name/id/hasChildren — no files, no metadata, no content-types.
+         * @summary Browse folders on behalf of the grantor
+         * @param {string} grantId 
+         * @param {string} [parent] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async browseFolders(grantId: string, parent?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DelegatedFolderNode>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.browseFolders(grantId, parent, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DelegatedBrowseGrantsAdminApi.browseFolders']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Flip an ACCEPTED grant to CONSUMED after using it to create a webhook. Single-use: subsequent browse calls return 410 Gone.
+         * @summary Mark grant as consumed
+         * @param {string} id 
+         * @param {ConsumeDelegatedGrantRequest} consumeDelegatedGrantRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async consume(id: string, consumeDelegatedGrantRequest: ConsumeDelegatedGrantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DelegatedGrantDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.consume(id, consumeDelegatedGrantRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DelegatedBrowseGrantsAdminApi.consume']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Admin UI polls this after creation to learn when the grantor has accepted/declined. 404 if the grant isn\'t yours.
+         * @summary Poll grant status
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGrant(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DelegatedGrantDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGrant(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DelegatedBrowseGrantsAdminApi.getGrant']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Optionally filter by ?status=PENDING|ACCEPTED|...
+         * @summary List grants I requested
+         * @param {ListMineStatusEnum} [status] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listMine(status?: ListMineStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DelegatedGrantDTO>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listMine(status, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DelegatedBrowseGrantsAdminApi.listMine']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Create a PENDING grant. Notifies the grantor via in-app + email. Grantor has 15 min to accept or the grant auto-expires.
+         * @summary Request a grant
+         * @param {CreateDelegatedGrantRequest} createDelegatedGrantRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async requestGrant(createDelegatedGrantRequest: CreateDelegatedGrantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DelegatedGrantDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.requestGrant(createDelegatedGrantRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DelegatedBrowseGrantsAdminApi.requestGrant']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * DelegatedBrowseGrantsAdminApi - factory interface
+ */
+export const DelegatedBrowseGrantsAdminApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DelegatedBrowseGrantsAdminApiFp(configuration)
+    return {
+        /**
+         * List folders under {parent} in the grantor\'s tree. Omit {parent} to list the grantor\'s root-level folders. Returns only name/id/hasChildren — no files, no metadata, no content-types.
+         * @summary Browse folders on behalf of the grantor
+         * @param {string} grantId 
+         * @param {string} [parent] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        browseFolders(grantId: string, parent?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<DelegatedFolderNode>> {
+            return localVarFp.browseFolders(grantId, parent, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Flip an ACCEPTED grant to CONSUMED after using it to create a webhook. Single-use: subsequent browse calls return 410 Gone.
+         * @summary Mark grant as consumed
+         * @param {string} id 
+         * @param {ConsumeDelegatedGrantRequest} consumeDelegatedGrantRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        consume(id: string, consumeDelegatedGrantRequest: ConsumeDelegatedGrantRequest, options?: RawAxiosRequestConfig): AxiosPromise<DelegatedGrantDTO> {
+            return localVarFp.consume(id, consumeDelegatedGrantRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Admin UI polls this after creation to learn when the grantor has accepted/declined. 404 if the grant isn\'t yours.
+         * @summary Poll grant status
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGrant(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DelegatedGrantDTO> {
+            return localVarFp.getGrant(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Optionally filter by ?status=PENDING|ACCEPTED|...
+         * @summary List grants I requested
+         * @param {ListMineStatusEnum} [status] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMine(status?: ListMineStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<DelegatedGrantDTO>> {
+            return localVarFp.listMine(status, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Create a PENDING grant. Notifies the grantor via in-app + email. Grantor has 15 min to accept or the grant auto-expires.
+         * @summary Request a grant
+         * @param {CreateDelegatedGrantRequest} createDelegatedGrantRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        requestGrant(createDelegatedGrantRequest: CreateDelegatedGrantRequest, options?: RawAxiosRequestConfig): AxiosPromise<DelegatedGrantDTO> {
+            return localVarFp.requestGrant(createDelegatedGrantRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DelegatedBrowseGrantsAdminApi - object-oriented interface
+ */
+export class DelegatedBrowseGrantsAdminApi extends BaseAPI {
+    /**
+     * List folders under {parent} in the grantor\'s tree. Omit {parent} to list the grantor\'s root-level folders. Returns only name/id/hasChildren — no files, no metadata, no content-types.
+     * @summary Browse folders on behalf of the grantor
+     * @param {string} grantId 
+     * @param {string} [parent] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public browseFolders(grantId: string, parent?: string, options?: RawAxiosRequestConfig) {
+        return DelegatedBrowseGrantsAdminApiFp(this.configuration).browseFolders(grantId, parent, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Flip an ACCEPTED grant to CONSUMED after using it to create a webhook. Single-use: subsequent browse calls return 410 Gone.
+     * @summary Mark grant as consumed
+     * @param {string} id 
+     * @param {ConsumeDelegatedGrantRequest} consumeDelegatedGrantRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public consume(id: string, consumeDelegatedGrantRequest: ConsumeDelegatedGrantRequest, options?: RawAxiosRequestConfig) {
+        return DelegatedBrowseGrantsAdminApiFp(this.configuration).consume(id, consumeDelegatedGrantRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Admin UI polls this after creation to learn when the grantor has accepted/declined. 404 if the grant isn\'t yours.
+     * @summary Poll grant status
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGrant(id: string, options?: RawAxiosRequestConfig) {
+        return DelegatedBrowseGrantsAdminApiFp(this.configuration).getGrant(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Optionally filter by ?status=PENDING|ACCEPTED|...
+     * @summary List grants I requested
+     * @param {ListMineStatusEnum} [status] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public listMine(status?: ListMineStatusEnum, options?: RawAxiosRequestConfig) {
+        return DelegatedBrowseGrantsAdminApiFp(this.configuration).listMine(status, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Create a PENDING grant. Notifies the grantor via in-app + email. Grantor has 15 min to accept or the grant auto-expires.
+     * @summary Request a grant
+     * @param {CreateDelegatedGrantRequest} createDelegatedGrantRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public requestGrant(createDelegatedGrantRequest: CreateDelegatedGrantRequest, options?: RawAxiosRequestConfig) {
+        return DelegatedBrowseGrantsAdminApiFp(this.configuration).requestGrant(createDelegatedGrantRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+export const ListMineStatusEnum = {
+    Pending: 'PENDING',
+    Accepted: 'ACCEPTED',
+    Declined: 'DECLINED',
+    Revoked: 'REVOKED',
+    Expired: 'EXPIRED',
+    Consumed: 'CONSUMED'
+} as const;
+export type ListMineStatusEnum = typeof ListMineStatusEnum[keyof typeof ListMineStatusEnum];