prioritize-client 1.3.0

package/dist/esm/apis/TasksApi.d.ts

@@ -0,0 +1,372 @@
+/**
+ * Prioritize API
+ * REST API of Prioritize, a resource, project and IoT orchestration platform. All endpoints live under /api/v1. From 1.0.0 on this REST surface is the stable public contract (SemVer); the Vaadin admin GUI and its @Route URLs are an implementation detail and NOT part of that promise. A few areas are marked \'experimental\' in their schema and may still change within the 1.x line.
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * Contact: peter.haller@prioritize-iot.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { TaskDTO, TaskRequest, TaskStatusRequest, TrackingSummary, WorkSession } from '../models/index';
+export interface TaskAssignGoalRequest {
+    id: number;
+    goalId: number;
+}
+export interface TaskAssignTaskRequest {
+    id: number;
+    actorId: number;
+}
+export interface TaskChangeStatusRequest {
+    id: number;
+    taskStatusRequest: TaskStatusRequest;
+}
+export interface TaskCreateTaskRequest {
+    projectId: number;
+    taskRequest: TaskRequest;
+}
+export interface TaskDeleteTaskRequest {
+    id: number;
+}
+export interface TaskGetTaskRequest {
+    id: number;
+}
+export interface TaskGetTrackingRequest {
+    id: number;
+}
+export interface TaskGetTrackingSessionsRequest {
+    id: number;
+}
+export interface TaskStartTrackingRequest {
+    id: number;
+}
+export interface TaskStopTrackingRequest {
+    id: number;
+}
+export interface TaskToggleTrackingRequest {
+    id: number;
+}
+export interface TaskUnassignGoalRequest {
+    id: number;
+}
+export interface TaskUnassignTaskRequest {
+    id: number;
+}
+export interface TaskUpdateTaskRequest {
+    id: number;
+    taskRequest: TaskRequest;
+}
+/**
+ * TasksApi - interface
+ *
+ * @export
+ * @interface TasksApiInterface
+ */
+export interface TasksApiInterface {
+    /**
+     *
+     * @summary Assign goal
+     * @param {number} id
+     * @param {number} goalId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskAssignGoalRaw(requestParameters: TaskAssignGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Assign goal
+     */
+    taskAssignGoal(requestParameters: TaskAssignGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Assign task
+     * @param {number} id
+     * @param {number} actorId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskAssignTaskRaw(requestParameters: TaskAssignTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Assign task
+     */
+    taskAssignTask(requestParameters: TaskAssignTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Change status
+     * @param {number} id
+     * @param {TaskStatusRequest} taskStatusRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskChangeStatusRaw(requestParameters: TaskChangeStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Change status
+     */
+    taskChangeStatus(requestParameters: TaskChangeStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Creates a task on the given project\'s blackboard
+     * @param {number} projectId
+     * @param {TaskRequest} taskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskCreateTaskRaw(requestParameters: TaskCreateTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Creates a task on the given project\'s blackboard
+     */
+    taskCreateTask(requestParameters: TaskCreateTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Delete task
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskDeleteTaskRaw(requestParameters: TaskDeleteTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete task
+     */
+    taskDeleteTask(requestParameters: TaskDeleteTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @summary Get task
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskGetTaskRaw(requestParameters: TaskGetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Get task
+     */
+    taskGetTask(requestParameters: TaskGetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Returns the total time tracked on the task (completed spans plus the running one, live)
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskGetTrackingRaw(requestParameters: TaskGetTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TrackingSummary>>;
+    /**
+     * Returns the total time tracked on the task (completed spans plus the running one, live)
+     */
+    taskGetTracking(requestParameters: TaskGetTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TrackingSummary>;
+    /**
+     *
+     * @summary Returns the individual tracked work sessions of the task (completed spans plus the running one)
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskGetTrackingSessionsRaw(requestParameters: TaskGetTrackingSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WorkSession>>>;
+    /**
+     * Returns the individual tracked work sessions of the task (completed spans plus the running one)
+     */
+    taskGetTrackingSessions(requestParameters: TaskGetTrackingSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WorkSession>>;
+    /**
+     *
+     * @summary Start tracking
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskStartTrackingRaw(requestParameters: TaskStartTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Start tracking
+     */
+    taskStartTracking(requestParameters: TaskStartTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Stop tracking
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskStopTrackingRaw(requestParameters: TaskStopTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Stop tracking
+     */
+    taskStopTracking(requestParameters: TaskStopTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Toggle tracking
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskToggleTrackingRaw(requestParameters: TaskToggleTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Toggle tracking
+     */
+    taskToggleTracking(requestParameters: TaskToggleTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Unassign goal
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskUnassignGoalRaw(requestParameters: TaskUnassignGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Unassign goal
+     */
+    taskUnassignGoal(requestParameters: TaskUnassignGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Unassign task
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskUnassignTaskRaw(requestParameters: TaskUnassignTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Unassign task
+     */
+    taskUnassignTask(requestParameters: TaskUnassignTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     *
+     * @summary Update task
+     * @param {number} id
+     * @param {TaskRequest} taskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApiInterface
+     */
+    taskUpdateTaskRaw(requestParameters: TaskUpdateTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Update task
+     */
+    taskUpdateTask(requestParameters: TaskUpdateTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+}
+/**
+ *
+ */
+export declare class TasksApi extends runtime.BaseAPI implements TasksApiInterface {
+    /**
+     * Assign goal
+     */
+    taskAssignGoalRaw(requestParameters: TaskAssignGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Assign goal
+     */
+    taskAssignGoal(requestParameters: TaskAssignGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Assign task
+     */
+    taskAssignTaskRaw(requestParameters: TaskAssignTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Assign task
+     */
+    taskAssignTask(requestParameters: TaskAssignTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Change status
+     */
+    taskChangeStatusRaw(requestParameters: TaskChangeStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Change status
+     */
+    taskChangeStatus(requestParameters: TaskChangeStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Creates a task on the given project\'s blackboard
+     */
+    taskCreateTaskRaw(requestParameters: TaskCreateTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Creates a task on the given project\'s blackboard
+     */
+    taskCreateTask(requestParameters: TaskCreateTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Delete task
+     */
+    taskDeleteTaskRaw(requestParameters: TaskDeleteTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete task
+     */
+    taskDeleteTask(requestParameters: TaskDeleteTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get task
+     */
+    taskGetTaskRaw(requestParameters: TaskGetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Get task
+     */
+    taskGetTask(requestParameters: TaskGetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Returns the total time tracked on the task (completed spans plus the running one, live)
+     */
+    taskGetTrackingRaw(requestParameters: TaskGetTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TrackingSummary>>;
+    /**
+     * Returns the total time tracked on the task (completed spans plus the running one, live)
+     */
+    taskGetTracking(requestParameters: TaskGetTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TrackingSummary>;
+    /**
+     * Returns the individual tracked work sessions of the task (completed spans plus the running one)
+     */
+    taskGetTrackingSessionsRaw(requestParameters: TaskGetTrackingSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WorkSession>>>;
+    /**
+     * Returns the individual tracked work sessions of the task (completed spans plus the running one)
+     */
+    taskGetTrackingSessions(requestParameters: TaskGetTrackingSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WorkSession>>;
+    /**
+     * Start tracking
+     */
+    taskStartTrackingRaw(requestParameters: TaskStartTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Start tracking
+     */
+    taskStartTracking(requestParameters: TaskStartTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Stop tracking
+     */
+    taskStopTrackingRaw(requestParameters: TaskStopTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Stop tracking
+     */
+    taskStopTracking(requestParameters: TaskStopTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Toggle tracking
+     */
+    taskToggleTrackingRaw(requestParameters: TaskToggleTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Toggle tracking
+     */
+    taskToggleTracking(requestParameters: TaskToggleTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Unassign goal
+     */
+    taskUnassignGoalRaw(requestParameters: TaskUnassignGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Unassign goal
+     */
+    taskUnassignGoal(requestParameters: TaskUnassignGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Unassign task
+     */
+    taskUnassignTaskRaw(requestParameters: TaskUnassignTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Unassign task
+     */
+    taskUnassignTask(requestParameters: TaskUnassignTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+    /**
+     * Update task
+     */
+    taskUpdateTaskRaw(requestParameters: TaskUpdateTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaskDTO>>;
+    /**
+     * Update task
+     */
+    taskUpdateTask(requestParameters: TaskUpdateTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaskDTO>;
+}