TaskChecklistService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• taskChecklistCreate
• taskChecklistInfo
• taskChecklistList
• taskChecklistRemove
• taskChecklistUpdate

Constructors

constructor

• new TaskChecklistService(httpRequest: BaseHttpRequest): TaskChecklistService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns TaskChecklistService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publictaskChecklistCreate

• taskChecklistCreate(__namedParameters: { requestBody: AddTaskCheckListParam }): CancelablePromise<{ data?: AddTaskCheckListResponse }>

• Add a checklist item Bot-compatible Adds an item to a task's checklist.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddTaskCheckListParam }

  Returns CancelablePromise<{ data?: AddTaskCheckListResponse }>

  any Successfully added the item to the checklist.

publictaskChecklistInfo

• taskChecklistInfo(__namedParameters: { id: string }): CancelablePromise<{ data?: GetTaskCheckListResponse }>

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

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { id: string }

  Returns CancelablePromise<{ data?: GetTaskCheckListResponse }>

  any Successfully retrieved information about the checklist item.

publictaskChecklistList

• taskChecklistList(__namedParameters: { limit?: number; offset?: string; taskId: string }): CancelablePromise<{ data?: GetTaskCheckListListResponse }>

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

  @throws

  ApiError

  ---

  Parameters

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

  Returns CancelablePromise<{ data?: GetTaskCheckListListResponse }>

  any Successfully retrieved items from the checklist.

publictaskChecklistRemove

• taskChecklistRemove(__namedParameters: { requestBody: DelTaskCheckListParam }): CancelablePromise<any>

• Delete a checklist item Bot-compatible Deletes an item in a task's checklist.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelTaskCheckListParam }

  Returns CancelablePromise<any>

  any Successfully deleted the checklist item.

publictaskChecklistUpdate

• taskChecklistUpdate(__namedParameters: { requestBody: PutTaskCheckListParam }): CancelablePromise<{ data?: PutTaskCheckListResponse }>

• Update a checklist item Bot-compatible Updates an existing item of a task's checklist.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: PutTaskCheckListParam }

  Returns CancelablePromise<{ data?: PutTaskCheckListResponse }>

  any Successfully updated the checklist item.