@emilgroup/task-sdk 1.0.1-beta.1

package/dist/api/tasks-api.d.ts

@@ -0,0 +1,366 @@
+/**
+ * EMIL TaskService
+ * The EMIL Task API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateTaskRequestDto } from '../models';
+import { CreateTaskResponseClass } from '../models';
+import { GetTaskResponseClass } from '../models';
+import { ListTasksResponseClass } from '../models';
+import { UpdateTaskRequestDto } from '../models';
+import { UpdateTaskResponseClass } from '../models';
+/**
+ * TasksApi - axios parameter creator
+ * @export
+ */
+export declare const TasksApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create task.
+     * @summary Create the task
+     * @param {CreateTaskRequestDto} createTaskRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTask: (createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete task.
+     * @summary Delete the task
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTask: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will get task.
+     * @summary Retrieve the task
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTask: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of tasks.
+     * @summary List tasks
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTasks: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update task.
+     * @summary Update the task
+     * @param {string} code
+     * @param {UpdateTaskRequestDto} updateTaskRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTask: (code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * TasksApi - functional programming interface
+ * @export
+ */
+export declare const TasksApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create task.
+     * @summary Create the task
+     * @param {CreateTaskRequestDto} createTaskRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTaskResponseClass>>;
+    /**
+     * This will delete task.
+     * @summary Delete the task
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTask(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This will get task.
+     * @summary Retrieve the task
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTask(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaskResponseClass>>;
+    /**
+     * Retrieves a list of tasks.
+     * @summary List tasks
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTasks(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>>;
+    /**
+     * This will update task.
+     * @summary Update the task
+     * @param {string} code
+     * @param {UpdateTaskRequestDto} updateTaskRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTask(code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTaskResponseClass>>;
+};
+/**
+ * TasksApi - factory interface
+ * @export
+ */
+export declare const TasksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create task.
+     * @summary Create the task
+     * @param {CreateTaskRequestDto} createTaskRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTaskResponseClass>;
+    /**
+     * This will delete task.
+     * @summary Delete the task
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTask(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This will get task.
+     * @summary Retrieve the task
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTask(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetTaskResponseClass>;
+    /**
+     * Retrieves a list of tasks.
+     * @summary List tasks
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTasks(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListTasksResponseClass>;
+    /**
+     * This will update task.
+     * @summary Update the task
+     * @param {string} code
+     * @param {UpdateTaskRequestDto} updateTaskRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTask(code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateTaskResponseClass>;
+};
+/**
+ * Request parameters for createTask operation in TasksApi.
+ * @export
+ * @interface TasksApiCreateTaskRequest
+ */
+export interface TasksApiCreateTaskRequest {
+    /**
+     *
+     * @type {CreateTaskRequestDto}
+     * @memberof TasksApiCreateTask
+     */
+    readonly createTaskRequestDto: CreateTaskRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof TasksApiCreateTask
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteTask operation in TasksApi.
+ * @export
+ * @interface TasksApiDeleteTaskRequest
+ */
+export interface TasksApiDeleteTaskRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof TasksApiDeleteTask
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof TasksApiDeleteTask
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getTask operation in TasksApi.
+ * @export
+ * @interface TasksApiGetTaskRequest
+ */
+export interface TasksApiGetTaskRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TasksApiGetTask
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TasksApiGetTask
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof TasksApiGetTask
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listTasks operation in TasksApi.
+ * @export
+ * @interface TasksApiListTasksRequest
+ */
+export interface TasksApiListTasksRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof TasksApiListTasks
+     */
+    readonly authorization?: string;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof TasksApiListTasks
+     */
+    readonly filter?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof TasksApiListTasks
+     */
+    readonly filters?: string;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof TasksApiListTasks
+     */
+    readonly order?: string;
+    /**
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
+     * @type {string}
+     * @memberof TasksApiListTasks
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateTask operation in TasksApi.
+ * @export
+ * @interface TasksApiUpdateTaskRequest
+ */
+export interface TasksApiUpdateTaskRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TasksApiUpdateTask
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateTaskRequestDto}
+     * @memberof TasksApiUpdateTask
+     */
+    readonly updateTaskRequestDto: UpdateTaskRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof TasksApiUpdateTask
+     */
+    readonly authorization?: string;
+}
+/**
+ * TasksApi - object-oriented interface
+ * @export
+ * @class TasksApi
+ * @extends {BaseAPI}
+ */
+export declare class TasksApi extends BaseAPI {
+    /**
+     * This will create task.
+     * @summary Create the task
+     * @param {TasksApiCreateTaskRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    createTask(requestParameters: TasksApiCreateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTaskResponseClass, any, {}>>;
+    /**
+     * This will delete task.
+     * @summary Delete the task
+     * @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    deleteTask(requestParameters: TasksApiDeleteTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This will get task.
+     * @summary Retrieve the task
+     * @param {TasksApiGetTaskRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    getTask(requestParameters: TasksApiGetTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTaskResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of tasks.
+     * @summary List tasks
+     * @param {TasksApiListTasksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    listTasks(requestParameters?: TasksApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponseClass, any, {}>>;
+    /**
+     * This will update task.
+     * @summary Update the task
+     * @param {TasksApiUpdateTaskRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    updateTask(requestParameters: TasksApiUpdateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTaskResponseClass, any, {}>>;
+}