@vanillabp/bc-official-gui-client 0.1.0 → 0.1.1

package/dist/apis/OfficialTasklistApi.d.ts

@@ -1,338 +0,0 @@
-import { InitOverrideFunction, ApiResponse, BaseAPI } from '../runtime.js';
-import { KwicRequest } from '../models/KwicRequest.js';
-import { KwicResults } from '../models/KwicResults.js';
-import { UserSearchResult } from '../models/UserSearchResult.js';
-import { UserTask } from '../models/UserTask.js';
-import { UserTaskIds } from '../models/UserTaskIds.js';
-import { UserTasks } from '../models/UserTasks.js';
-import { UserTasksRequest } from '../models/UserTasksRequest.js';
-import { UserTasksUpdateRequest } from '../models/UserTasksUpdateRequest.js';
-import '../models/SearchQuery.js';
-import '../models/KwicResult.js';
-import '../models/Person.js';
-import '../models/Group.js';
-import '../models/UiUriType.js';
-import '../models/Page.js';
-import '../models/UserTaskRetrieveMode.js';
-
-/**
- * gui
- * Official GUI API
- *
- * The version of the OpenAPI document: 1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-interface AssignTaskRequest {
-    userTaskId: string;
-    unassign?: boolean;
-    userId?: string;
-}
-interface AssignTasksRequest {
-    userTaskIds: UserTaskIds;
-    unassign?: boolean;
-    userId?: string;
-}
-interface ClaimTaskRequest {
-    userTaskId: string;
-    unclaim?: boolean;
-}
-interface ClaimTasksRequest {
-    userTaskIds: UserTaskIds;
-    unclaim?: boolean;
-}
-interface FindUsersRequest {
-    query?: string;
-    limit?: number;
-}
-interface GetUserTaskRequest {
-    userTaskId: string;
-    markAsRead?: boolean;
-}
-interface GetUserTaskKwicResultsRequest {
-    kwicRequest: KwicRequest;
-    initialTimestamp?: Date;
-    path?: string;
-    query?: string;
-}
-interface GetUserTasksRequest {
-    userTasksRequest: UserTasksRequest;
-    initialTimestamp?: Date;
-}
-interface GetUserTasksUpdateRequest {
-    userTasksUpdateRequest: UserTasksUpdateRequest;
-    initialTimestamp?: Date;
-}
-interface MarkTaskAsReadRequest {
-    userTaskId: string;
-    unread?: boolean;
-}
-interface MarkTasksAsReadRequest {
-    userTaskIds: UserTaskIds;
-    unread?: boolean;
-}
-/**
- * OfficialTasklistApi - interface
- *
- * @export
- * @interface OfficialTasklistApiInterface
- */
-interface OfficialTasklistApiInterface {
-    /**
-     *
-     * @summary assign or unassign a task to a user
-     * @param {string} userTaskId
-     * @param {boolean} [unassign]
-     * @param {string} [userId]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    assignTaskRaw(requestParameters: AssignTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * assign or unassign a task to a user
-     */
-    assignTask(requestParameters: AssignTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     *
-     * @summary assign or unassign tasks to a user
-     * @param {UserTaskIds} userTaskIds
-     * @param {boolean} [unassign]
-     * @param {string} [userId]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    assignTasksRaw(requestParameters: AssignTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * assign or unassign tasks to a user
-     */
-    assignTasks(requestParameters: AssignTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     *
-     * @summary claim or unclaim a task to the current user
-     * @param {string} userTaskId
-     * @param {boolean} [unclaim]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    claimTaskRaw(requestParameters: ClaimTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * claim or unclaim a task to the current user
-     */
-    claimTask(requestParameters: ClaimTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     *
-     * @summary claim or unclaim tasks to the current user
-     * @param {UserTaskIds} userTaskIds
-     * @param {boolean} [unclaim]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    claimTasksRaw(requestParameters: ClaimTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * claim or unclaim tasks to the current user
-     */
-    claimTasks(requestParameters: ClaimTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     *
-     * @summary Find users
-     * @param {string} [query]
-     * @param {number} [limit]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    findUsersRaw(requestParameters: FindUsersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<UserSearchResult>>;
-    /**
-     * Find users
-     */
-    findUsers(requestParameters: FindUsersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<UserSearchResult>;
-    /**
-     *
-     * @summary Fetch data of one single User task
-     * @param {string} userTaskId
-     * @param {boolean} [markAsRead]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    getUserTaskRaw(requestParameters: GetUserTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<UserTask>>;
-    /**
-     * Fetch data of one single User task
-     */
-    getUserTask(requestParameters: GetUserTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<UserTask>;
-    /**
-     *
-     * @summary Kwic results over user tasks
-     * @param {KwicRequest} kwicRequest
-     * @param {Date} [initialTimestamp]
-     * @param {string} [path]
-     * @param {string} [query]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    getUserTaskKwicResultsRaw(requestParameters: GetUserTaskKwicResultsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<KwicResults>>;
-    /**
-     * Kwic results over user tasks
-     */
-    getUserTaskKwicResults(requestParameters: GetUserTaskKwicResultsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<KwicResults>;
-    /**
-     *
-     * @summary User tasks to be shown in a list view
-     * @param {UserTasksRequest} userTasksRequest
-     * @param {Date} [initialTimestamp]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    getUserTasksRaw(requestParameters: GetUserTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<UserTasks>>;
-    /**
-     * User tasks to be shown in a list view
-     */
-    getUserTasks(requestParameters: GetUserTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<UserTasks>;
-    /**
-     *
-     * @summary Updated list of usertasks
-     * @param {UserTasksUpdateRequest} userTasksUpdateRequest
-     * @param {Date} [initialTimestamp]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    getUserTasksUpdateRaw(requestParameters: GetUserTasksUpdateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<UserTasks>>;
-    /**
-     * Updated list of usertasks
-     */
-    getUserTasksUpdate(requestParameters: GetUserTasksUpdateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<UserTasks>;
-    /**
-     *
-     * @summary mark a task as read or unread
-     * @param {string} userTaskId
-     * @param {boolean} [unread]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    markTaskAsReadRaw(requestParameters: MarkTaskAsReadRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * mark a task as read or unread
-     */
-    markTaskAsRead(requestParameters: MarkTaskAsReadRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     *
-     * @summary mark tasks as read or unread
-     * @param {UserTaskIds} userTaskIds
-     * @param {boolean} [unread]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OfficialTasklistApiInterface
-     */
-    markTasksAsReadRaw(requestParameters: MarkTasksAsReadRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * mark tasks as read or unread
-     */
-    markTasksAsRead(requestParameters: MarkTasksAsReadRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-}
-/**
- *
- */
-declare class OfficialTasklistApi extends BaseAPI implements OfficialTasklistApiInterface {
-    /**
-     * assign or unassign a task to a user
-     */
-    assignTaskRaw(requestParameters: AssignTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * assign or unassign a task to a user
-     */
-    assignTask(requestParameters: AssignTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     * assign or unassign tasks to a user
-     */
-    assignTasksRaw(requestParameters: AssignTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * assign or unassign tasks to a user
-     */
-    assignTasks(requestParameters: AssignTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     * claim or unclaim a task to the current user
-     */
-    claimTaskRaw(requestParameters: ClaimTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * claim or unclaim a task to the current user
-     */
-    claimTask(requestParameters: ClaimTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     * claim or unclaim tasks to the current user
-     */
-    claimTasksRaw(requestParameters: ClaimTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * claim or unclaim tasks to the current user
-     */
-    claimTasks(requestParameters: ClaimTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     * Find users
-     */
-    findUsersRaw(requestParameters: FindUsersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<UserSearchResult>>;
-    /**
-     * Find users
-     */
-    findUsers(requestParameters?: FindUsersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<UserSearchResult>;
-    /**
-     * Fetch data of one single User task
-     */
-    getUserTaskRaw(requestParameters: GetUserTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<UserTask>>;
-    /**
-     * Fetch data of one single User task
-     */
-    getUserTask(requestParameters: GetUserTaskRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<UserTask>;
-    /**
-     * Kwic results over user tasks
-     */
-    getUserTaskKwicResultsRaw(requestParameters: GetUserTaskKwicResultsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<KwicResults>>;
-    /**
-     * Kwic results over user tasks
-     */
-    getUserTaskKwicResults(requestParameters: GetUserTaskKwicResultsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<KwicResults>;
-    /**
-     * User tasks to be shown in a list view
-     */
-    getUserTasksRaw(requestParameters: GetUserTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<UserTasks>>;
-    /**
-     * User tasks to be shown in a list view
-     */
-    getUserTasks(requestParameters: GetUserTasksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<UserTasks>;
-    /**
-     * Updated list of usertasks
-     */
-    getUserTasksUpdateRaw(requestParameters: GetUserTasksUpdateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<UserTasks>>;
-    /**
-     * Updated list of usertasks
-     */
-    getUserTasksUpdate(requestParameters: GetUserTasksUpdateRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<UserTasks>;
-    /**
-     * mark a task as read or unread
-     */
-    markTaskAsReadRaw(requestParameters: MarkTaskAsReadRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * mark a task as read or unread
-     */
-    markTaskAsRead(requestParameters: MarkTaskAsReadRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-    /**
-     * mark tasks as read or unread
-     */
-    markTasksAsReadRaw(requestParameters: MarkTasksAsReadRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
-    /**
-     * mark tasks as read or unread
-     */
-    markTasksAsRead(requestParameters: MarkTasksAsReadRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
-}
-
-export { AssignTaskRequest, AssignTasksRequest, ClaimTaskRequest, ClaimTasksRequest, FindUsersRequest, GetUserTaskKwicResultsRequest, GetUserTaskRequest, GetUserTasksRequest, GetUserTasksUpdateRequest, MarkTaskAsReadRequest, MarkTasksAsReadRequest, OfficialTasklistApi, OfficialTasklistApiInterface };