langchain_community.utilities.clickup.ClickupAPIWrapper

class langchain_community.utilities.clickup.ClickupAPIWrapper

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]]

Parse appropriate content from the list of teams.

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

• include – fields to include in new model

• exclude – fields to exclude from new model, as with values this takes precedence over include

• update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

• deep – set to True to make a deep copy of the model

Returns

new model instance

create_folder(query: str) → Dict

Creates a new folder.

create_list(query: str) → Dict

Creates a new list.

create_task(query: str) → Dict

Creates a new task.

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

classmethod from_orm(obj: Any) → Model

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

Get the URL to get an access code.

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

Get the access token.

get_authorized_teams() → Dict[Any, Any]

Get all teams for the user.

get_default_params() → Dict

get_folders() → Dict

Get all the folders for the team.

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

Get the headers for the request.

get_lists() → Dict

Get all available lists.

get_spaces() → Dict

Get all spaces for the team.

get_task(query: str, fault_tolerant: bool = True) → Dict

Retrieve a specific task.

get_task_attribute(query: str) → Dict

Update an attribute of a specified task.

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model

classmethod parse_obj(obj: Any) → Model

classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model

query_tasks(query: str) → Dict

Query tasks that match certain fields

run(mode: str, query: str) → str

Run the API.

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny

classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode

classmethod update_forward_refs(**localns: Any) → None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

update_task(query: str) → Dict

Update an attribute of a specified task.

update_task_assignees(query: str) → Dict

Add or remove assignees of a specified task.

classmethod validate(value: Any) → Model