TaskService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• taskAssetAppend
• taskAssigneeAdd
• taskAssigneeRemove
• taskCreate
• taskFollowAdd
• taskFollowRemove
• taskInfo
• taskList
• taskListByColumn
• taskMove
• taskMyTaskList
• taskRemove
• taskStatusUpdate
• taskUpdate

Constructors

constructor

• new TaskService(httpRequest: BaseHttpRequest): TaskService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns TaskService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publictaskAssetAppend

• taskAssetAppend(__namedParameters: { requestBody: AppendAssetTaskParam }): CancelablePromise<any>

• Add attachments Adds file attachments to a task.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AppendAssetTaskParam }

  Returns CancelablePromise<any>

  any Successfully added the attachments to the task.

publictaskAssigneeAdd

• taskAssigneeAdd(__namedParameters: { requestBody: AddTaskAssigneeParam }): CancelablePromise<{ data?: AddTaskAssigneeResponse }>

• Add an assignee Bot-compatible Adds an assignee to a task.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddTaskAssigneeParam }

  Returns CancelablePromise<{ data?: AddTaskAssigneeResponse }>

  any Successfully added an assignee for the task.

publictaskAssigneeRemove

• taskAssigneeRemove(__namedParameters: { requestBody: DelTaskAssigneeParam }): CancelablePromise<any>

• Remove an assignee Bot-compatible Removes a member from the managing role for a task.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelTaskAssigneeParam }

  Returns CancelablePromise<any>

  any Successfully removed the assignee.

publictaskCreate

• taskCreate(__namedParameters: { requestBody: AddTaskParam }): CancelablePromise<{ data?: AddTaskResponse }>

• Create a task Bot-compatible Creates a task in a project.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddTaskParam }

  Returns CancelablePromise<{ data?: AddTaskResponse }>

  any Successfully posted the task.

publictaskFollowAdd

• taskFollowAdd(__namedParameters: { requestBody: AddTaskFollowParam }): CancelablePromise<{ data?: AddTaskFollowResponse }>

• Add a collaborator Bot-compatible Adds a collaborator to a task.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddTaskFollowParam }

  Returns CancelablePromise<{ data?: AddTaskFollowResponse }>

  any Successfully added the collaborator.

publictaskFollowRemove

• taskFollowRemove(__namedParameters: { requestBody: DelTaskFollowParam }): CancelablePromise<any>

• Remove a collaborator Bot-compatible Removes a collaborator from a task.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelTaskFollowParam }

  Returns CancelablePromise<any>

  any Successfully removed the collaborator.

publictaskInfo

• taskInfo(__namedParameters: { bodyType?: plain | json_string; id: string }): CancelablePromise<{ data?: GetTaskInfoResponse }>

• Get a task's information Bot-compatible Retrieves information about a task.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { bodyType?: plain | json_string; id: string }

  Returns CancelablePromise<{ data?: GetTaskInfoResponse }>

  any Successfully retrieved the task's information.

publictaskList

• taskList(__namedParameters: { limit?: number; offset?: string; parentId?: string; projectId: string; workspaceId?: string }): CancelablePromise<{ data?: GetTaskListProjectResponse }>

• List out tasks Bot-compatible Lists out a given number of tasks from a project. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { limit?: number; offset?: string; parentId?: string; projectId: string; workspaceId?: string }

  Returns CancelablePromise<{ data?: GetTaskListProjectResponse }>

  any Successfully retrieved the tasks.

publictaskListByColumn

• taskListByColumn(__namedParameters: { bucketId: string; limit?: number; offset?: string; projectId: string }): CancelablePromise<{ data?: GetTaskListByColumnResponse }>

• List out tasks by bucket Bot-compatible Lists out a given number of tasks from a bucket. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { bucketId: string; limit?: number; offset?: string; projectId: string }

  Returns CancelablePromise<{ data?: GetTaskListByColumnResponse }>

  any Successfully retrieved the tasks.

publictaskMove

• taskMove(__namedParameters: { requestBody: MoveTaskParam }): CancelablePromise<{ data?: MoveTaskResponse }>

• Move a task Bot-compatible Moves a task into another project.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: MoveTaskParam }

  Returns CancelablePromise<{ data?: MoveTaskResponse }>

  any Successfully moved the task.

publictaskMyTaskList

• taskMyTaskList(__namedParameters: { limit?: number; offset?: string; workspaceId: string }): CancelablePromise<{ data?: GetTaskListMineResponse }>

• List out my tasks Bot-compatible Lists out "my tasks" of the user from a workspace.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { limit?: number; offset?: string; workspaceId: string }

  Returns CancelablePromise<{ data?: GetTaskListMineResponse }>

  any Successfully retrieved my tasks.

publictaskRemove

• taskRemove(__namedParameters: { requestBody: DelTaskParam }): CancelablePromise<any>

• Delete a task Bot-compatible Deletes a task from a project.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelTaskParam }

  Returns CancelablePromise<any>

  any Successfully deleted the task.

publictaskStatusUpdate

• taskStatusUpdate(__namedParameters: { requestBody: { project_id?: string; task_id?: string; to_status_id?: string; workspace_id?: string } }): CancelablePromise<TaskResponse>

• Update the status of a task Updates the status of a task.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: { project_id?: string; task_id?: string; to_status_id?: string; workspace_id?: string } }

  Returns CancelablePromise<TaskResponse>

  TaskResponse Successfully updated the status of the task.

publictaskUpdate

• taskUpdate(__namedParameters: { requestBody: PutTaskParam }): CancelablePromise<{ data?: PutTaskResponse }>

• Update a task Bot-compatible Updates a task in a project.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: PutTaskParam }

  Returns CancelablePromise<{ data?: PutTaskResponse }>

  any Successfully updated the task.