langchain_community.utilities.clickup.ClickupAPIWrapper

class langchain_community.utilities.clickup.ClickupAPIWrapper[source]

Bases: BaseModel

Wrapper for Clickup API.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param access_token: Optional[str] = None
param folder_id: Optional[str] = None
param list_id: Optional[str] = None
param space_id: Optional[str] = None
param team_id: Optional[str] = None
attempt_parse_teams(input_dict: dict) Dict[str, List[dict]][source]

Parse appropriate content from the list of teams.

Parameters

input_dict (dict) –

Return type

Dict[str, List[dict]]

create_folder(query: str) Dict[source]

Creates a new folder.

Parameters

query (str) –

Return type

Dict

create_list(query: str) Dict[source]

Creates a new list.

Parameters

query (str) –

Return type

Dict

create_task(query: str) Dict[source]

Creates a new task.

Parameters

query (str) –

Return type

Dict

classmethod get_access_code_url(oauth_client_id: str, redirect_uri: str = 'https://google.com') str[source]

Get the URL to get an access code.

Parameters
  • oauth_client_id (str) –

  • redirect_uri (str) –

Return type

str

classmethod get_access_token(oauth_client_id: str, oauth_client_secret: str, code: str) Optional[str][source]

Get the access token.

Parameters
  • oauth_client_id (str) –

  • oauth_client_secret (str) –

  • code (str) –

Return type

Optional[str]

get_authorized_teams() Dict[Any, Any][source]

Get all teams for the user.

Return type

Dict[Any, Any]

get_default_params() Dict[source]
Return type

Dict

get_folders() Dict[source]

Get all the folders for the team.

Return type

Dict

get_headers() Mapping[str, Union[str, bytes]][source]

Get the headers for the request.

Return type

Mapping[str, Union[str, bytes]]

get_lists() Dict[source]

Get all available lists.

Return type

Dict

get_spaces() Dict[source]

Get all spaces for the team.

Return type

Dict

get_task(query: str, fault_tolerant: bool = True) Dict[source]

Retrieve a specific task.

Parameters
  • query (str) –

  • fault_tolerant (bool) –

Return type

Dict

get_task_attribute(query: str) Dict[source]

Update an attribute of a specified task.

Parameters

query (str) –

Return type

Dict

query_tasks(query: str) Dict[source]

Query tasks that match certain fields

Parameters

query (str) –

Return type

Dict

run(mode: str, query: str) str[source]

Run the API.

Parameters
  • mode (str) –

  • query (str) –

Return type

str

update_task(query: str) Dict[source]

Update an attribute of a specified task.

Parameters

query (str) –

Return type

Dict

update_task_assignees(query: str) Dict[source]

Add or remove assignees of a specified task.

Parameters

query (str) –

Return type

Dict

Examples using ClickupAPIWrapper