pipedrive 32.2.0 → 33.0.0

package/dist/esm/versions/v2/api/tasks-api.d.ts

@@ -0,0 +1,333 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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 { AxiosInstance } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { AddTaskRequest } from '../models';
+import { AddTaskResponse } from '../models';
+import { DeleteTaskResponse } from '../models';
+import { GetTaskResponse } from '../models';
+import { GetTasksResponse } from '../models';
+import { UpdateTaskRequest } from '../models';
+import { UpdateTaskResponse } from '../models';
+/**
+ * TasksApi - axios parameter creator
+ * @export
+ */
+export declare const TasksApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Adds a new task.
+     * @summary Add a task
+     * @param {AddTaskRequest} AddTaskRequest
+
+     * @throws {RequiredError}
+     */
+    addTask: (AddTaskRequest: AddTaskRequest) => Promise<RequestArgs>;
+    /**
+     * Marks a task as deleted. If the task has subtasks, those will also be deleted.
+     * @summary Delete a task
+     * @param {number} id The ID of the task
+
+     * @throws {RequiredError}
+     */
+    deleteTask: (id: number) => Promise<RequestArgs>;
+    /**
+     * Returns the details of a specific task.
+     * @summary Get details of a task
+     * @param {number} id The ID of the task
+
+     * @throws {RequiredError}
+     */
+    getTask: (id: number) => Promise<RequestArgs>;
+    /**
+     * Returns all tasks.
+     * @summary Get all tasks
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+     * @param {boolean} [is_done] Whether the task is done or not. If omitted, both done and not done tasks are returned.
+     * @param {boolean} [is_milestone] Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned.
+     * @param {number} [assignee_id] If supplied, only tasks assigned to this user are returned
+     * @param {number} [project_id] If supplied, only tasks belonging to this project are returned
+     * @param {string} [parent_task_id] If &#x60;null&#x60; is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned.
+
+     * @throws {RequiredError}
+     */
+    getTasks: (cursor?: string, limit?: number, is_done?: boolean, is_milestone?: boolean, assignee_id?: number, project_id?: number, parent_task_id?: string) => Promise<RequestArgs>;
+    /**
+     * Updates a task.
+     * @summary Update a task
+     * @param {number} id The ID of the task
+     * @param {UpdateTaskRequest} [UpdateTaskRequest]
+
+     * @throws {RequiredError}
+     */
+    updateTask: (id: number, UpdateTaskRequest?: UpdateTaskRequest) => Promise<RequestArgs>;
+};
+/**
+ * TasksApi - functional programming interface
+ * @export
+ */
+export declare const TasksApiFp: (configuration?: Configuration) => {
+    /**
+     * Adds a new task.
+     * @summary Add a task
+     * @param {AddTaskRequest} AddTaskRequest
+
+     * @throws {RequiredError}
+     */
+    addTask(AddTaskRequest: AddTaskRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddTaskResponse>>;
+    /**
+     * Marks a task as deleted. If the task has subtasks, those will also be deleted.
+     * @summary Delete a task
+     * @param {number} id The ID of the task
+
+     * @throws {RequiredError}
+     */
+    deleteTask(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteTaskResponse>>;
+    /**
+     * Returns the details of a specific task.
+     * @summary Get details of a task
+     * @param {number} id The ID of the task
+
+     * @throws {RequiredError}
+     */
+    getTask(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTaskResponse>>;
+    /**
+     * Returns all tasks.
+     * @summary Get all tasks
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+     * @param {boolean} [is_done] Whether the task is done or not. If omitted, both done and not done tasks are returned.
+     * @param {boolean} [is_milestone] Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned.
+     * @param {number} [assignee_id] If supplied, only tasks assigned to this user are returned
+     * @param {number} [project_id] If supplied, only tasks belonging to this project are returned
+     * @param {string} [parent_task_id] If &#x60;null&#x60; is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned.
+
+     * @throws {RequiredError}
+     */
+    getTasks(cursor?: string, limit?: number, is_done?: boolean, is_milestone?: boolean, assignee_id?: number, project_id?: number, parent_task_id?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTasksResponse>>;
+    /**
+     * Updates a task.
+     * @summary Update a task
+     * @param {number} id The ID of the task
+     * @param {UpdateTaskRequest} [UpdateTaskRequest]
+
+     * @throws {RequiredError}
+     */
+    updateTask(id: number, UpdateTaskRequest?: UpdateTaskRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateTaskResponse>>;
+};
+/**
+ * TasksApi - factory interface
+ * @export
+ */
+export declare const TasksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Adds a new task.
+     * @summary Add a task
+     * @param {TasksApiAddTaskRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    addTask(requestParameters: TasksApiAddTaskRequest): Promise<AddTaskResponse>;
+    /**
+     * Marks a task as deleted. If the task has subtasks, those will also be deleted.
+     * @summary Delete a task
+     * @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteTask(requestParameters: TasksApiDeleteTaskRequest): Promise<DeleteTaskResponse>;
+    /**
+     * Returns the details of a specific task.
+     * @summary Get details of a task
+     * @param {TasksApiGetTaskRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getTask(requestParameters: TasksApiGetTaskRequest): Promise<GetTaskResponse>;
+    /**
+     * Returns all tasks.
+     * @summary Get all tasks
+     * @param {TasksApiGetTasksRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getTasks(requestParameters?: TasksApiGetTasksRequest): Promise<GetTasksResponse>;
+    /**
+     * Updates a task.
+     * @summary Update a task
+     * @param {TasksApiUpdateTaskRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    updateTask(requestParameters: TasksApiUpdateTaskRequest): Promise<UpdateTaskResponse>;
+};
+/**
+ * Request parameters for addTask operation in TasksApi.
+ * @export
+ * @interface TasksApiAddTaskRequest
+ */
+export interface TasksApiAddTaskRequest {
+    /**
+     *
+     * @type {AddTaskRequest}
+     * @memberof TasksApiAddTask
+     */
+    readonly AddTaskRequest: AddTaskRequest;
+}
+/**
+ * Request parameters for deleteTask operation in TasksApi.
+ * @export
+ * @interface TasksApiDeleteTaskRequest
+ */
+export interface TasksApiDeleteTaskRequest {
+    /**
+     * The ID of the task
+     * @type {number}
+     * @memberof TasksApiDeleteTask
+     */
+    readonly id: number;
+}
+/**
+ * Request parameters for getTask operation in TasksApi.
+ * @export
+ * @interface TasksApiGetTaskRequest
+ */
+export interface TasksApiGetTaskRequest {
+    /**
+     * The ID of the task
+     * @type {number}
+     * @memberof TasksApiGetTask
+     */
+    readonly id: number;
+}
+/**
+ * Request parameters for getTasks operation in TasksApi.
+ * @export
+ * @interface TasksApiGetTasksRequest
+ */
+export interface TasksApiGetTasksRequest {
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof TasksApiGetTasks
+     */
+    readonly cursor?: string;
+    /**
+     * For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+     * @type {number}
+     * @memberof TasksApiGetTasks
+     */
+    readonly limit?: number;
+    /**
+     * Whether the task is done or not. If omitted, both done and not done tasks are returned.
+     * @type {boolean}
+     * @memberof TasksApiGetTasks
+     */
+    readonly is_done?: boolean;
+    /**
+     * Whether the task is a milestone or not. If omitted, both milestone and non-milestone tasks are returned.
+     * @type {boolean}
+     * @memberof TasksApiGetTasks
+     */
+    readonly is_milestone?: boolean;
+    /**
+     * If supplied, only tasks assigned to this user are returned
+     * @type {number}
+     * @memberof TasksApiGetTasks
+     */
+    readonly assignee_id?: number;
+    /**
+     * If supplied, only tasks belonging to this project are returned
+     * @type {number}
+     * @memberof TasksApiGetTasks
+     */
+    readonly project_id?: number;
+    /**
+     * If &#x60;null&#x60; is supplied, only root-level tasks (without a parent) are returned. If an integer is supplied, only subtasks of that specific task are returned. By default all tasks are returned.
+     * @type {string}
+     * @memberof TasksApiGetTasks
+     */
+    readonly parent_task_id?: string;
+}
+/**
+ * Request parameters for updateTask operation in TasksApi.
+ * @export
+ * @interface TasksApiUpdateTaskRequest
+ */
+export interface TasksApiUpdateTaskRequest {
+    /**
+     * The ID of the task
+     * @type {number}
+     * @memberof TasksApiUpdateTask
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {UpdateTaskRequest}
+     * @memberof TasksApiUpdateTask
+     */
+    readonly UpdateTaskRequest?: UpdateTaskRequest;
+}
+/**
+ * TasksApi - object-oriented interface
+ * @export
+ * @class TasksApi
+ * @extends {BaseAPI}
+ */
+export declare class TasksApi extends BaseAPI {
+    /**
+     * Adds a new task.
+     * @summary Add a task
+     * @param {TasksApiAddTaskRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    addTask(requestParameters: TasksApiAddTaskRequest): Promise<AddTaskResponse>;
+    /**
+     * Marks a task as deleted. If the task has subtasks, those will also be deleted.
+     * @summary Delete a task
+     * @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    deleteTask(requestParameters: TasksApiDeleteTaskRequest): Promise<DeleteTaskResponse>;
+    /**
+     * Returns the details of a specific task.
+     * @summary Get details of a task
+     * @param {TasksApiGetTaskRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    getTask(requestParameters: TasksApiGetTaskRequest): Promise<GetTaskResponse>;
+    /**
+     * Returns all tasks.
+     * @summary Get all tasks
+     * @param {TasksApiGetTasksRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    getTasks(requestParameters?: TasksApiGetTasksRequest): Promise<GetTasksResponse>;
+    /**
+     * Updates a task.
+     * @summary Update a task
+     * @param {TasksApiUpdateTaskRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof TasksApi
+     */
+    updateTask(requestParameters: TasksApiUpdateTaskRequest): Promise<UpdateTaskResponse>;
+}