Skip to content

TrelloClient

Attributes

TRIGGER_OPERATIONS module-attribute 

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewCardInBoardV3': {'operation_id': 'OnNewCardInBoardV3', 'path': '/{connectionId}/v3/trigger/boards/{board_id}/actions', 'method': 'get', 'required_parameters': ['board_id'], 'callback_payload_type': 'CardInAction'}, 'OnNewCardInListV3': {'operation_id': 'OnNewCardInListV3', 'path': '/{connectionId}/v3/trigger/lists/{list_id}/actions', 'method': 'get', 'required_parameters': ['board_id', 'list_id'], 'callback_payload_type': 'CardInAction'}}

Classes

Card dataclass 

Card(id: Optional[str] = None, check_item_states: Optional[List[CheckItemState]] = None, closed: Optional[bool] = None, date_last_activity: Optional[str] = None, desc: Optional[str] = None, id_board: Optional[str] = None, id_list: Optional[str] = None, id_members_voted: Optional[List[str]] = None, id_short: Optional[int] = None, id_attachment_cover: Optional[str] = None, manual_cover_attachment: Optional[bool] = None, id_labels: Optional[List[str]] = None, name: Optional[str] = None, pos: Optional[float] = None, short_link: Optional[str] = None, badges: Optional[Badges] = None, due: Optional[str] = None, short_url: Optional[str] = None, subscribed: Optional[bool] = None, url: Optional[str] = None, checklists: Optional[List[Checklist]] = None)

Response for List the cards in a board

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique id of the card.

check_item_states class-attribute instance-attribute 
check_item_states: Optional[List[CheckItemState]] = field(default=None, metadata={'wire_name': 'checkItemStates'})

The check item states in the card.

closed class-attribute instance-attribute 
closed: Optional[bool] = None

A boolean value (true, false) determining whether or not the card is closed.

date_last_activity class-attribute instance-attribute 
date_last_activity: Optional[str] = field(default=None, metadata={'wire_name': 'dateLastActivity'})

The datetime of last activity on the card.

desc class-attribute instance-attribute 
desc: Optional[str] = None

The description of the card.

id_board class-attribute instance-attribute 
id_board: Optional[str] = field(default=None, metadata={'wire_name': 'idBoard'})

The unique Id of the board which the card belongs to.

id_list class-attribute instance-attribute 
id_list: Optional[str] = field(default=None, metadata={'wire_name': 'idList'})

The unique Id of the list which the card belongs to.

id_members_voted class-attribute instance-attribute 
id_members_voted: Optional[List[str]] = field(default=None, metadata={'wire_name': 'idMembersVoted'})

The unique Ids of the voting members.

id_short class-attribute instance-attribute 
id_short: Optional[int] = field(default=None, metadata={'wire_name': 'idShort'})

The short Id of the card.

id_attachment_cover class-attribute instance-attribute 
id_attachment_cover: Optional[str] = field(default=None, metadata={'wire_name': 'idAttachmentCover'})

The unique Id of the attachment cover.

manual_cover_attachment class-attribute instance-attribute 
manual_cover_attachment: Optional[bool] = field(default=None, metadata={'wire_name': 'manualCoverAttachment'})

A boolean value (true, false) determining whether or not the card has a manual cover attachment.

id_labels class-attribute instance-attribute 
id_labels: Optional[List[str]] = field(default=None, metadata={'wire_name': 'idLabels'})

A list of label Ids on the card.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the card.

pos class-attribute instance-attribute 
pos: Optional[float] = None

The position of the card.

short_link: Optional[str] = field(default=None, metadata={'wire_name': 'shortLink'})

A short link to the card.

due class-attribute instance-attribute 
due: Optional[str] = None

The due date of the card.

short_url class-attribute instance-attribute 
short_url: Optional[str] = field(default=None, metadata={'wire_name': 'shortUrl'})

The short url link to the card.

subscribed class-attribute instance-attribute 
subscribed: Optional[bool] = None

A boolean value (true, false) determining whether or not the card is subscribed to.

url class-attribute instance-attribute 
url: Optional[str] = None

The full url to the card.

checklists class-attribute instance-attribute 
checklists: Optional[List[Checklist]] = None

The set of board checklists.

CardWithChecklists dataclass 

CardWithChecklists(id: Optional[str] = None, check_item_states: Optional[List[CheckItemState]] = None, closed: Optional[bool] = None, date_last_activity: Optional[str] = None, desc: Optional[str] = None, id_board: Optional[str] = None, id_list: Optional[str] = None, id_members_voted: Optional[List[str]] = None, id_short: Optional[int] = None, id_attachment_cover: Optional[str] = None, manual_cover_attachment: Optional[bool] = None, id_labels: Optional[List[str]] = None, name: Optional[str] = None, pos: Optional[float] = None, short_link: Optional[str] = None, badges: Optional[Badges] = None, due: Optional[str] = None, short_url: Optional[str] = None, subscribed: Optional[bool] = None, url: Optional[str] = None, checklists: Optional[List[Checklist]] = None)

Response for Get a card by id

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique id of the card.

check_item_states class-attribute instance-attribute 
check_item_states: Optional[List[CheckItemState]] = field(default=None, metadata={'wire_name': 'checkItemStates'})

The check item states in the card.

closed class-attribute instance-attribute 
closed: Optional[bool] = None

A boolean value (true, false) determining whether or not the card is closed.

date_last_activity class-attribute instance-attribute 
date_last_activity: Optional[str] = field(default=None, metadata={'wire_name': 'dateLastActivity'})

The datetime of last activity on the card.

desc class-attribute instance-attribute 
desc: Optional[str] = None

The description of the card.

id_board class-attribute instance-attribute 
id_board: Optional[str] = field(default=None, metadata={'wire_name': 'idBoard'})

The unique Id of the board which the card belongs to.

id_list class-attribute instance-attribute 
id_list: Optional[str] = field(default=None, metadata={'wire_name': 'idList'})

The unique Id of the list which the card belongs to.

id_members_voted class-attribute instance-attribute 
id_members_voted: Optional[List[str]] = field(default=None, metadata={'wire_name': 'idMembersVoted'})

The unique Ids of the voting members.

id_short class-attribute instance-attribute 
id_short: Optional[int] = field(default=None, metadata={'wire_name': 'idShort'})

The short Id of the card.

id_attachment_cover class-attribute instance-attribute 
id_attachment_cover: Optional[str] = field(default=None, metadata={'wire_name': 'idAttachmentCover'})

The unique Id of the attachment cover.

manual_cover_attachment class-attribute instance-attribute 
manual_cover_attachment: Optional[bool] = field(default=None, metadata={'wire_name': 'manualCoverAttachment'})

A boolean value (true, false) determining whether or not the card has a manual cover attachment.

id_labels class-attribute instance-attribute 
id_labels: Optional[List[str]] = field(default=None, metadata={'wire_name': 'idLabels'})

A list of label Ids on the card.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the card.

pos class-attribute instance-attribute 
pos: Optional[float] = None

The position of the card.

short_link: Optional[str] = field(default=None, metadata={'wire_name': 'shortLink'})

A short link to the card.

due class-attribute instance-attribute 
due: Optional[str] = None

The due date of the card.

short_url class-attribute instance-attribute 
short_url: Optional[str] = field(default=None, metadata={'wire_name': 'shortUrl'})

The short url link to the card.

subscribed class-attribute instance-attribute 
subscribed: Optional[bool] = None

A boolean value (true, false) determining whether or not the card is subscribed to.

url class-attribute instance-attribute 
url: Optional[str] = None

The full url to the card.

checklists class-attribute instance-attribute 
checklists: Optional[List[Checklist]] = None

The set of card checklists.

ObjectEntity dataclass 

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Response for Delete a card

Attributes

additional_properties class-attribute instance-attribute 
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Board dataclass 

Board(id: Optional[str] = None, closed: Optional[bool] = None, date_last_activity: Optional[str] = None, date_last_view: Optional[str] = None, desc: Optional[str] = None, id_organization: Optional[str] = None, invitations: Optional[List[str]] = None, invited: Optional[bool] = None, label_names: Optional[Label] = None, memberships: Optional[List[Membership]] = None, name: Optional[str] = None, pinned: Optional[bool] = None, power_ups: Optional[List[str]] = None, perfs: Optional[Perfs] = None, short_link: Optional[str] = None, short_url: Optional[str] = None, starred: Optional[bool] = None, subscribed: Optional[bool] = None, url: Optional[str] = None)

Response for List boards

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique Id of the board.

closed class-attribute instance-attribute 
closed: Optional[bool] = None

A boolean value (true, false) determining whether or not the board is closed.

date_last_activity class-attribute instance-attribute 
date_last_activity: Optional[str] = field(default=None, metadata={'wire_name': 'dateLastActivity'})

Date of the last activity on the board.

date_last_view class-attribute instance-attribute 
date_last_view: Optional[str] = field(default=None, metadata={'wire_name': 'dateLastView'})

Date of the last time the board is viewed.

desc class-attribute instance-attribute 
desc: Optional[str] = None

The description of the board.

id_organization class-attribute instance-attribute 
id_organization: Optional[str] = field(default=None, metadata={'wire_name': 'idOrganization'})

The id of the organization.

invitations class-attribute instance-attribute 
invitations: Optional[List[str]] = None

The list of invitations on the board.

invited class-attribute instance-attribute 
invited: Optional[bool] = None

A boolean value (true, false) determining whether or not the account is invited to the board.

memberships class-attribute instance-attribute 
memberships: Optional[List[Membership]] = None

The set of board memberships.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the board.

pinned class-attribute instance-attribute 
pinned: Optional[bool] = None

A boolean value (true, false) determining whether or not the board is pinned.

power_ups class-attribute instance-attribute 
power_ups: Optional[List[str]] = field(default=None, metadata={'wire_name': 'powerUps'})

The set of power ups on the board.

short_link: Optional[str] = field(default=None, metadata={'wire_name': 'shortLink'})

The short link of the board.

short_url class-attribute instance-attribute 
short_url: Optional[str] = field(default=None, metadata={'wire_name': 'shortUrl'})

The short url to the board.

starred class-attribute instance-attribute 
starred: Optional[bool] = None

A value determining whether or not the board is starred.

subscribed class-attribute instance-attribute 
subscribed: Optional[bool] = None

A value determining whether or not the account is subscribed to the board.

url class-attribute instance-attribute 
url: Optional[str] = None

The full url of the board.

BoardWithChecklists dataclass 

BoardWithChecklists(id: Optional[str] = None, closed: Optional[bool] = None, date_last_activity: Optional[str] = None, date_last_view: Optional[str] = None, desc: Optional[str] = None, id_organization: Optional[str] = None, invitations: Optional[List[str]] = None, invited: Optional[bool] = None, label_names: Optional[Label] = None, memberships: Optional[List[Membership]] = None, name: Optional[str] = None, pinned: Optional[bool] = None, power_ups: Optional[List[str]] = None, perfs: Optional[Perfs] = None, short_link: Optional[str] = None, short_url: Optional[str] = None, starred: Optional[bool] = None, subscribed: Optional[bool] = None, url: Optional[str] = None, checklists: Optional[List[Checklist]] = None)

Response for Get a board by Id

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique Id of the board.

closed class-attribute instance-attribute 
closed: Optional[bool] = None

A boolean value (true, false) determining whether or not the board is closed.

date_last_activity class-attribute instance-attribute 
date_last_activity: Optional[str] = field(default=None, metadata={'wire_name': 'dateLastActivity'})

Date of the last activity on the board.

date_last_view class-attribute instance-attribute 
date_last_view: Optional[str] = field(default=None, metadata={'wire_name': 'dateLastView'})

Date of the last time the board is viewed.

desc class-attribute instance-attribute 
desc: Optional[str] = None

The description of the board.

id_organization class-attribute instance-attribute 
id_organization: Optional[str] = field(default=None, metadata={'wire_name': 'idOrganization'})

The id of the organization.

invitations class-attribute instance-attribute 
invitations: Optional[List[str]] = None

The list of invitations on the board.

invited class-attribute instance-attribute 
invited: Optional[bool] = None

A boolean value (true, false) determining whether or not the account is invited to the board.

memberships class-attribute instance-attribute 
memberships: Optional[List[Membership]] = None

The set of board memberships.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the board.

pinned class-attribute instance-attribute 
pinned: Optional[bool] = None

A boolean value (true, false) determining whether or not the board is pinned.

power_ups class-attribute instance-attribute 
power_ups: Optional[List[str]] = field(default=None, metadata={'wire_name': 'powerUps'})

The set of power ups on the board.

short_link: Optional[str] = field(default=None, metadata={'wire_name': 'shortLink'})

The short link of the board.

short_url class-attribute instance-attribute 
short_url: Optional[str] = field(default=None, metadata={'wire_name': 'shortUrl'})

The short url to the board.

starred class-attribute instance-attribute 
starred: Optional[bool] = None

A value determining whether or not the board is starred.

subscribed class-attribute instance-attribute 
subscribed: Optional[bool] = None

A value determining whether or not the account is subscribed to the board.

url class-attribute instance-attribute 
url: Optional[str] = None

The full url of the board.

checklists class-attribute instance-attribute 
checklists: Optional[List[Checklist]] = None

The set of board checklists.

List dataclass 

List(id: Optional[str] = None, name: Optional[str] = None, closed: Optional[bool] = None, id_board: Optional[str] = None, pos: Optional[float] = None, subscribed: Optional[bool] = None, cards: Optional[List[Card]] = None, board: Optional[Board] = None)

Response for List the card lists in a board

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique Id of the list.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the list.

closed class-attribute instance-attribute 
closed: Optional[bool] = None

A boolean value (true, false) determining whether or not the list is closed.

id_board class-attribute instance-attribute 
id_board: Optional[str] = field(default=None, metadata={'wire_name': 'idBoard'})

The unique Id of the board which the list belongs to.

pos class-attribute instance-attribute 
pos: Optional[float] = None

The position of the list.

subscribed class-attribute instance-attribute 
subscribed: Optional[bool] = None

A boolean value (true, false) determining whether or not to the account is subscribed to the list.

cards class-attribute instance-attribute 
cards: Optional[List[Card]] = None

The cards inside the list.

CreateListResponse dataclass 

CreateListResponse(id: Optional[str] = None, name: Optional[str] = None, id_board: Optional[str] = None, pos: Optional[float] = None)

Response for Update a list

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique Id of the list.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the list.

id_board class-attribute instance-attribute 
id_board: Optional[str] = field(default=None, metadata={'wire_name': 'idBoard'})

The unique Id of the board the list belongs to.

pos class-attribute instance-attribute 
pos: Optional[float] = None

The position of the list.

Team dataclass 

Team(id: Optional[str] = None, desc: Optional[str] = None, display_name: Optional[str] = None, id_boards: Optional[List[str]] = None, billable_member_count: Optional[int] = None, memberships: Optional[List[Membership]] = None, web_site: Optional[str] = None, prefs: Optional[TeamPreferences] = None)

Response for List teams you are a member of

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique ID of the team.

desc class-attribute instance-attribute 
desc: Optional[str] = None

The description of the team.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The display name of the team.

id_boards class-attribute instance-attribute 
id_boards: Optional[List[str]] = field(default=None, metadata={'wire_name': 'idBoards'})

The boards assigned to this team.

billable_member_count class-attribute instance-attribute 
billable_member_count: Optional[int] = field(default=None, metadata={'wire_name': 'billableMemberCount'})

The number of members in this team.

memberships class-attribute instance-attribute 
memberships: Optional[List[Membership]] = None

The memberships for this team.

web_site class-attribute instance-attribute 
web_site: Optional[str] = field(default=None, metadata={'wire_name': 'WebSite'})

The team website.

Member dataclass 

Member(id: Optional[str] = None, full_name: Optional[str] = None, username: Optional[str] = None, initials: Optional[str] = None)

Response for List members of a team

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique Id of the member.

full_name class-attribute instance-attribute 
full_name: Optional[str] = field(default=None, metadata={'wire_name': 'fullName'})

The full name of the member.

username class-attribute instance-attribute 
username: Optional[str] = None

The username of the member.

initials class-attribute instance-attribute 
initials: Optional[str] = None

The initials of the member.

BoardLabel dataclass 

BoardLabel(id: Optional[str] = None, name: Optional[str] = None, color: Optional[str] = None)

Response for List labels of a board

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The Label Id

name class-attribute instance-attribute 
name: Optional[str] = None

The Label name.

color class-attribute instance-attribute 
color: Optional[str] = None

The Label color.

Comment dataclass 

Comment(member_creator: Optional[Member] = None, text: Optional[str] = None, date: Optional[str] = None)

Response for List comments for a card

Attributes

text class-attribute instance-attribute 
text: Optional[str] = None

The text of the comment.

date class-attribute instance-attribute 
date: Optional[str] = None

The datetime the comment was left.

CardInAction dataclass 

CardInAction(id: Optional[str] = None, id_short: Optional[int] = None, name: Optional[str] = None, short_link: Optional[str] = None, due: Optional[str] = None)

Response for When a new card is added to a board

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique id of the card.

id_short class-attribute instance-attribute 
id_short: Optional[int] = field(default=None, metadata={'wire_name': 'idShort'})

The short Id of the card.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the card.

short_link: Optional[str] = field(default=None, metadata={'wire_name': 'shortLink'})

A short link to the card.

due class-attribute instance-attribute 
due: Optional[str] = None

The due date of the card.

CheckItemState dataclass 

CheckItemState(id_check_item: Optional[str] = None, state: Optional[str] = None)

Definition: CheckItemState

Attributes

id_check_item class-attribute instance-attribute 
id_check_item: Optional[str] = field(default=None, metadata={'wire_name': 'idCheckItem'})

ID of the check item.

state class-attribute instance-attribute 
state: Optional[str] = None

State of the check item.

Badges dataclass 

Badges(votes: Optional[int] = None, viewing_member_voted: Optional[bool] = None, subscribed: Optional[bool] = None, fogbugz: Optional[str] = None, check_items: Optional[int] = None, check_items_checked: Optional[int] = None, comments: Optional[int] = None, attachments: Optional[int] = None, description: Optional[bool] = None, due: Optional[str] = None)

Definition: Badges

Attributes

votes class-attribute instance-attribute 
votes: Optional[int] = field(default=None, metadata={'wire_name': 'Votes'})

The number of votes on the card badges.

viewing_member_voted class-attribute instance-attribute 
viewing_member_voted: Optional[bool] = field(default=None, metadata={'wire_name': 'ViewingMemberVoted'})

A boolean value (true, false) determining whether or not viewing members voted on the badge.

subscribed class-attribute instance-attribute 
subscribed: Optional[bool] = field(default=None, metadata={'wire_name': 'Subscribed'})

A boolean value (true, false) determining whether or not the account is subscribed to the card badges.

fogbugz class-attribute instance-attribute 
fogbugz: Optional[str] = field(default=None, metadata={'wire_name': 'Fogbugz'})

The fogbugz of the badges.

check_items class-attribute instance-attribute 
check_items: Optional[int] = field(default=None, metadata={'wire_name': 'CheckItems'})

The number of check items in the badge.

check_items_checked class-attribute instance-attribute 
check_items_checked: Optional[int] = field(default=None, metadata={'wire_name': 'CheckItemsChecked'})

The number of checked check items in the badge.

comments class-attribute instance-attribute 
comments: Optional[int] = field(default=None, metadata={'wire_name': 'Comments'})

The comments on the badge.

attachments class-attribute instance-attribute 
attachments: Optional[int] = field(default=None, metadata={'wire_name': 'Attachments'})

The attachments on the badge.

description class-attribute instance-attribute 
description: Optional[bool] = field(default=None, metadata={'wire_name': 'Description'})

The description of the badge.

due class-attribute instance-attribute 
due: Optional[str] = field(default=None, metadata={'wire_name': 'Due'})

The due date of the badge.

UpdateCard dataclass 

UpdateCard(name: Optional[str] = None, desc: Optional[str] = None, closed: Optional[bool] = None, id_members_array: Optional[List[str]] = None, id_attachment_cover: Optional[str] = None, id_board: Optional[str] = None, id_list: Optional[str] = None, pos: Optional[str] = None, due: Optional[str] = None, subscribed: Optional[bool] = None)

Definition: UpdateCard

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

The updated name of the new card.

desc class-attribute instance-attribute 
desc: Optional[str] = None

The updated description of the new card.

closed class-attribute instance-attribute 
closed: Optional[bool] = None

A boolean value (true, false) determining whether or not the card is closed.

id_members_array class-attribute instance-attribute 
id_members_array: Optional[List[str]] = field(default=None, metadata={'wire_name': 'idMembersArray'})

An array of member Ids to attach to the card.

id_attachment_cover class-attribute instance-attribute 
id_attachment_cover: Optional[str] = field(default=None, metadata={'wire_name': 'idAttachmentCover'})

The id of the attachment to attach to the card.

id_board class-attribute instance-attribute 
id_board: Optional[str] = field(default=None, metadata={'wire_name': 'idBoard'})

The id of the board to attach the card to.

id_list class-attribute instance-attribute 
id_list: Optional[str] = field(default=None, metadata={'wire_name': 'idList'})

The id of the list to attach the card to.

pos class-attribute instance-attribute 
pos: Optional[str] = None

The position of the card on the page. Specify top, bottom, or a positive number. Note this is used in relation to existing card locations so the resulting location may not match the exact value provided.

due class-attribute instance-attribute 
due: Optional[str] = None

The due date of the card.

subscribed class-attribute instance-attribute 
subscribed: Optional[bool] = None

A boolean value (true, false) determining whether or not to subscribe to the card.

CreateCard dataclass 

CreateCard(id_list: Optional[str] = None, name: Optional[str] = None, desc: Optional[str] = None, pos: Optional[str] = None, id_members_array: Optional[List[str]] = None, id_labels_array: Optional[List[str]] = None, url_source: Optional[str] = None, file_source: Optional[str] = None, id_card_source: Optional[str] = None, keep_from_source: Optional[str] = None, due: Optional[str] = None)

Definition: CreateCard

Attributes

id_list class-attribute instance-attribute 
id_list: Optional[str] = field(default=None, metadata={'wire_name': 'idList'})

The id of the list that the card should be added to.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the new card.

desc class-attribute instance-attribute 
desc: Optional[str] = None

The description of the new card.

pos class-attribute instance-attribute 
pos: Optional[str] = None

The position of the card. Specify top, bottom, or a positive number. Note this is used in relation to existing card locations so the resulting location may not match the exact value provided.

id_members_array class-attribute instance-attribute 
id_members_array: Optional[List[str]] = field(default=None, metadata={'wire_name': 'idMembersArray'})

An array of member Ids to attach to the card.

id_labels_array class-attribute instance-attribute 
id_labels_array: Optional[List[str]] = field(default=None, metadata={'wire_name': 'idLabelsArray'})

An array of label Ids to attach to the card.

url_source class-attribute instance-attribute 
url_source: Optional[str] = field(default=None, metadata={'wire_name': 'urlSource'})

Source url of the card. Has to be a URL starting with http:// or https:// or null.

file_source class-attribute instance-attribute 
file_source: Optional[str] = field(default=None, metadata={'wire_name': 'fileSource'})

Source file of the card.

id_card_source class-attribute instance-attribute 
id_card_source: Optional[str] = field(default=None, metadata={'wire_name': 'idCardSource'})

The Id of the card to copy into a new card.

keep_from_source class-attribute instance-attribute 
keep_from_source: Optional[str] = field(default=None, metadata={'wire_name': 'keepFromSource'})

Properties of the card to copy over from the source.

due class-attribute instance-attribute 
due: Optional[str] = None

The due date of the card.

Label dataclass 

Label(green: Optional[str] = None, yellow: Optional[str] = None, orange: Optional[str] = None, red: Optional[str] = None, purple: Optional[str] = None, blue: Optional[str] = None, sky: Optional[str] = None, lime: Optional[str] = None, pink: Optional[str] = None, black: Optional[str] = None)

Definition: Label

Attributes

green class-attribute instance-attribute 
green: Optional[str] = None

The value of the green label.

yellow class-attribute instance-attribute 
yellow: Optional[str] = None

The value of the yellow label.

orange class-attribute instance-attribute 
orange: Optional[str] = None

The value of the orange label.

red class-attribute instance-attribute 
red: Optional[str] = None

The value of the red label.

purple class-attribute instance-attribute 
purple: Optional[str] = None

The value of the purple label.

blue class-attribute instance-attribute 
blue: Optional[str] = None

The value of the blue label.

sky class-attribute instance-attribute 
sky: Optional[str] = None

The value of the sky blue label.

lime class-attribute instance-attribute 
lime: Optional[str] = None

The value of the lime green label.

pink class-attribute instance-attribute 
pink: Optional[str] = None

The value of the pink label.

black class-attribute instance-attribute 
black: Optional[str] = None

The value of the black label.

Membership dataclass 

Membership(id: Optional[str] = None, id_member: Optional[str] = None, member_type: Optional[str] = None, unconfirmed: Optional[bool] = None)

Definition: Membership

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique Id of the membership.

id_member class-attribute instance-attribute 
id_member: Optional[str] = field(default=None, metadata={'wire_name': 'idMember'})

The unique Id of the member.

member_type class-attribute instance-attribute 
member_type: Optional[str] = field(default=None, metadata={'wire_name': 'memberType'})

The type of member.

unconfirmed class-attribute instance-attribute 
unconfirmed: Optional[bool] = None

A boolean value (true, false) determining whether or not the membership is unconfirmed.

Perfs dataclass 

Perfs(permission_level: Optional[str] = None, voting: Optional[str] = None, comments: Optional[str] = None, invitations: Optional[str] = None, self_join: Optional[bool] = None, card_covers: Optional[bool] = None, calendar_feed_enabled: Optional[bool] = None, background: Optional[str] = None, background_color: Optional[str] = None, background_image: Optional[str] = None, background_image_scaled: Optional[str] = None, background_tile: Optional[bool] = None, background_brightness: Optional[str] = None, can_be_public: Optional[bool] = None, can_be_org: Optional[bool] = None, can_be_private: Optional[bool] = None, can_invite: Optional[bool] = None)

Definition: Perfs

Attributes

permission_level class-attribute instance-attribute 
permission_level: Optional[str] = field(default=None, metadata={'wire_name': 'permissionLevel'})

The permission level of the object.

voting class-attribute instance-attribute 
voting: Optional[str] = None

Who can vote on the object.

comments class-attribute instance-attribute 
comments: Optional[str] = None

Who can comment on the object.

invitations class-attribute instance-attribute 
invitations: Optional[str] = None

Who can invite people to the object.

self_join class-attribute instance-attribute 
self_join: Optional[bool] = field(default=None, metadata={'wire_name': 'selfJoin'})

A boolean value (true, false) determining whether or not the object can self join.

card_covers class-attribute instance-attribute 
card_covers: Optional[bool] = field(default=None, metadata={'wire_name': 'cardCovers'})

A boolean value (true, false) determining whether or not the object has access to card covers.

calendar_feed_enabled class-attribute instance-attribute 
calendar_feed_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'calendarFeedEnabled'})

A boolean value (true, false) determining whether or not the calendar feed enabled.

background class-attribute instance-attribute 
background: Optional[str] = None

The background of the object.

background_color class-attribute instance-attribute 
background_color: Optional[str] = field(default=None, metadata={'wire_name': 'backgroundColor'})

The background color of the object, in hex notation.

background_image class-attribute instance-attribute 
background_image: Optional[str] = field(default=None, metadata={'wire_name': 'backgroundImage'})

The background image of the object.

background_image_scaled class-attribute instance-attribute 
background_image_scaled: Optional[str] = field(default=None, metadata={'wire_name': 'backgroundImageScaled'})

The scaled version of the background image.

background_tile class-attribute instance-attribute 
background_tile: Optional[bool] = field(default=None, metadata={'wire_name': 'backgroundTile'})

The background tile of the object.

background_brightness class-attribute instance-attribute 
background_brightness: Optional[str] = field(default=None, metadata={'wire_name': 'backgroundBrightness'})

The brightness of the object background.

can_be_public class-attribute instance-attribute 
can_be_public: Optional[bool] = field(default=None, metadata={'wire_name': 'canBePublic'})

A boolean value (true, false) determining whether or not the object can be public.

can_be_org class-attribute instance-attribute 
can_be_org: Optional[bool] = field(default=None, metadata={'wire_name': 'canBeOrg'})

A boolean value (true, false) determining whether or not the object can be part of the organization

can_be_private class-attribute instance-attribute 
can_be_private: Optional[bool] = field(default=None, metadata={'wire_name': 'canBePrivate'})

A boolean value (true, false) determining whether or not the object can be private.

can_invite class-attribute instance-attribute 
can_invite: Optional[bool] = field(default=None, metadata={'wire_name': 'canInvite'})

A boolean value (true, false) determining whether or not the object can have invititations.

UpdateBoard dataclass 

UpdateBoard(name: Optional[str] = None, default_lists: Optional[str] = None, desc: Optional[str] = None, id_organization: Optional[str] = None, prefs_permission_level: Optional[str] = None, prefs_comments: Optional[str] = None, prefs_invitations: Optional[str] = None, prefs_card_covers: Optional[str] = None, prefs_background: Optional[str] = None, prefs_voting: Optional[str] = None, prefs_card_aging: Optional[str] = None, enable_calendar: Optional[str] = None)

Definition: UpdateBoard

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the board.

default_lists class-attribute instance-attribute 
default_lists: Optional[str] = field(default=None, metadata={'wire_name': 'defaultLists'})

A string (true, false) determining whether or not to create default lists.

desc class-attribute instance-attribute 
desc: Optional[str] = None

The description of the board.

id_organization class-attribute instance-attribute 
id_organization: Optional[str] = field(default=None, metadata={'wire_name': 'idOrganization'})

The id of the team.

prefs_permission_level class-attribute instance-attribute 
prefs_permission_level: Optional[str] = field(default=None, metadata={'wire_name': 'prefs_permissionLevel'})

The permission level of the board.

prefs_comments class-attribute instance-attribute 
prefs_comments: Optional[str] = None

The comment preferences on the board. Valid options are 'disabled', 'members', 'observers', 'org' or 'public'.

prefs_invitations class-attribute instance-attribute 
prefs_invitations: Optional[str] = None

The invitation preferences of the board. Valid options are 'admins' or 'members'.

prefs_card_covers class-attribute instance-attribute 
prefs_card_covers: Optional[str] = field(default=None, metadata={'wire_name': 'prefs_cardCovers'})

A string (true, false) determining whether or not to use card covers.

prefs_background class-attribute instance-attribute 
prefs_background: Optional[str] = None

The background color of the board.

prefs_voting class-attribute instance-attribute 
prefs_voting: Optional[str] = None

The voting power-up preferences of the board.

prefs_card_aging class-attribute instance-attribute 
prefs_card_aging: Optional[str] = field(default=None, metadata={'wire_name': 'prefs_cardAging'})

The card aging power-up preferences of the board.

enable_calendar class-attribute instance-attribute 
enable_calendar: Optional[str] = None

A string (true, false) determining whether or not to enable calendar power-up

TeamPreferences dataclass 

TeamPreferences(permission_level: Optional[str] = None)

Definition: TeamPreferences

Attributes

permission_level class-attribute instance-attribute 
permission_level: Optional[str] = field(default=None, metadata={'wire_name': 'permissionLevel'})

The permission level of the team.

Webhook dataclass 

Webhook(id: Optional[str] = None, description: Optional[str] = None, id_model: Optional[str] = None, callback_u_r_l: Optional[str] = None, active: Optional[bool] = None, consecutive_failures: Optional[float] = None, first_consecutive_fail_date: Optional[str] = None)

Definition: Webhook

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique Id of the webhook.

description class-attribute instance-attribute 
description: Optional[str] = None

Brief Description of the webhook

id_model class-attribute instance-attribute 
id_model: Optional[str] = field(default=None, metadata={'wire_name': 'idModel'})

ID of the model to be monitored (i.e. card,board, etc.)

callback_u_r_l class-attribute instance-attribute 
callback_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'callbackURL'})

The callbackURL to receive webhook notifications

active class-attribute instance-attribute 
active: Optional[bool] = None

Determines whether the webhook is active and sending POST requests.

consecutive_failures class-attribute instance-attribute 
consecutive_failures: Optional[float] = field(default=None, metadata={'wire_name': 'consecutiveFailures'})

The number of consecutive Failures in posting webhook notifications.

first_consecutive_fail_date class-attribute instance-attribute 
first_consecutive_fail_date: Optional[str] = field(default=None, metadata={'wire_name': 'firstConsecutiveFailDate'})

The date of First Consecutive Failure.

CommentPost dataclass 

CommentPost(text: Optional[str] = None)

Definition: CommentPost

Attributes

text class-attribute instance-attribute 
text: Optional[str] = None

The text of the comment.

CreateBoard dataclass 

CreateBoard(name: Optional[str] = None, default_lists: Optional[str] = None, desc: Optional[str] = None, id_organization: Optional[str] = None, prefs_permission_level: Optional[str] = None, prefs_comments: Optional[str] = None, prefs_invitations: Optional[str] = None, prefs_card_covers: Optional[str] = None, prefs_background: Optional[str] = None, prefs_voting: Optional[str] = None, prefs_card_aging: Optional[str] = None, enable_calendar: Optional[str] = None)

Definition: CreateBoard

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the board.

default_lists class-attribute instance-attribute 
default_lists: Optional[str] = field(default=None, metadata={'wire_name': 'defaultLists'})

A string (true, false) determining whether or not to create default lists.

desc class-attribute instance-attribute 
desc: Optional[str] = None

The description of the board.

id_organization class-attribute instance-attribute 
id_organization: Optional[str] = field(default=None, metadata={'wire_name': 'idOrganization'})

The id of the team.

prefs_permission_level class-attribute instance-attribute 
prefs_permission_level: Optional[str] = field(default=None, metadata={'wire_name': 'prefs_permissionLevel'})

The permission level of the board. Valid options are 'org', 'private', or 'public'.

prefs_comments class-attribute instance-attribute 
prefs_comments: Optional[str] = None

The comment preferences of the board.

prefs_invitations class-attribute instance-attribute 
prefs_invitations: Optional[str] = None

The invitation preferences of the board.

prefs_card_covers class-attribute instance-attribute 
prefs_card_covers: Optional[str] = field(default=None, metadata={'wire_name': 'prefs_cardCovers'})

A string (true, false) determining whether or not to use card covers.

prefs_background class-attribute instance-attribute 
prefs_background: Optional[str] = None

The background color of the board.

prefs_voting class-attribute instance-attribute 
prefs_voting: Optional[str] = None

The voting power-up preferences of the board.

prefs_card_aging class-attribute instance-attribute 
prefs_card_aging: Optional[str] = field(default=None, metadata={'wire_name': 'prefs_cardAging'})

The card aging power-up preferences of the board.

enable_calendar class-attribute instance-attribute 
enable_calendar: Optional[str] = None

A string (true, false) determining whether or not to enable calendar power-up.

CreateList dataclass 

CreateList(name: Optional[str] = None, id_board: Optional[str] = None, pos: Optional[str] = None, id_list_source: Optional[str] = None)

Definition: CreateList

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the list.

id_board class-attribute instance-attribute 
id_board: Optional[str] = field(default=None, metadata={'wire_name': 'idBoard'})

The unique Id of the board to create the list in.

pos class-attribute instance-attribute 
pos: Optional[str] = None

The position of the list. Specify top, bottom, or a positive number.

id_list_source class-attribute instance-attribute 
id_list_source: Optional[str] = field(default=None, metadata={'wire_name': 'idListSource'})

The id of the list to copy into the new list.

Checklist dataclass 

Checklist(id: Optional[str] = None, name: Optional[str] = None, pos: Optional[int] = None, id_board: Optional[str] = None, id_card: Optional[str] = None, check_items: Optional[List[Checkitem]] = None)

Definition: Checklist

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique Id of the checklist.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of the checklist.

pos class-attribute instance-attribute 
pos: Optional[int] = None

The position of the checklist.

id_board class-attribute instance-attribute 
id_board: Optional[str] = field(default=None, metadata={'wire_name': 'idBoard'})

The unique Id of the board.

id_card class-attribute instance-attribute 
id_card: Optional[str] = field(default=None, metadata={'wire_name': 'idCard'})

The unique Id of the card.

check_items class-attribute instance-attribute 
check_items: Optional[List[Checkitem]] = field(default=None, metadata={'wire_name': 'checkItems'})

The list of the checklist items

Checkitem dataclass 

Checkitem(id: Optional[str] = None, name: Optional[str] = None, name_data: Optional[Dict[str, Any]] = None, pos: Optional[float] = None, state: Optional[str] = None, due: Optional[str] = None, id_member: Optional[str] = None, id_checklist: Optional[str] = None)

Definition: Checkitem

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

The unique Id of the checkitem.

name class-attribute instance-attribute 
name: Optional[str] = None

The name of them checkitem.

name_data class-attribute instance-attribute 
name_data: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'nameData'})

The nameData of them checkitem.

pos class-attribute instance-attribute 
pos: Optional[float] = None

The position of the checkitem.

state class-attribute instance-attribute 
state: Optional[str] = None

The state of the checkitem.

due class-attribute instance-attribute 
due: Optional[str] = None

The due date of the checkitem.

id_member class-attribute instance-attribute 
id_member: Optional[str] = field(default=None, metadata={'wire_name': 'idMember'})

The unique Id of the member.

id_checklist class-attribute instance-attribute 
id_checklist: Optional[str] = field(default=None, metadata={'wire_name': 'idChecklist'})

The unique Id of the checklist.

ClientSubscription dataclass 

ClientSubscription(notification_u_r_l: Optional[str] = None)

Definition: ClientSubscription

Attributes

notification_u_r_l class-attribute instance-attribute 
notification_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'NotificationURL'})

Callback url to the flow engine. Expected as part of the request and provided by Flow.

SubscriptionResponse dataclass 

SubscriptionResponse(id: Optional[str] = None, notification_u_r_l: Optional[str] = None, resource: Optional[str] = None, notification_type: Optional[str] = None)

Definition: SubscriptionResponse

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Id of the subscription

notification_u_r_l class-attribute instance-attribute 
notification_u_r_l: Optional[str] = field(default=None, metadata={'wire_name': 'NotificationURL'})

Notification Url

resource class-attribute instance-attribute 
resource: Optional[str] = None

Resource of the subscription request

notification_type class-attribute instance-attribute 
notification_type: Optional[str] = field(default=None, metadata={'wire_name': 'notificationType'})

Notification Type

SubscriptionPayload dataclass 

SubscriptionPayload(action: Optional[Dict[str, Any]] = None)

Definition: SubscriptionPayload

Attributes

action class-attribute instance-attribute 
action: Optional[Dict[str, Any]] = None

webhook action

TrelloClient 

TrelloClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for trello connector.

Initialize a TrelloClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

 required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

list_cards_async async 
list_cards_async(board_id: str, actions: Optional[str] = None, attachments: Optional[bool] = None, attachment_fields: Optional[str] = None, stickers: Optional[bool] = None, members: Optional[bool] = None, memeber_fields: Optional[str] = None, check_item_states: Optional[bool] = None, checklists: Optional[str] = None, limit: Optional[int] = None, since: Optional[str] = None, before: Optional[str] = None, filter: Optional[str] = None, fields: Optional[str] = None) -> dict[str, Any] | None

List the cards in a board

List the cards matching the query parameters in a specific board.

list_cards_simple_async async 
list_cards_simple_async(board_id: str) -> dict[str, Any] | None

A simple version of the list cards

A simple version of the list cards API method used by dynamic values.

get_card_async async 
get_card_async(card_id: str, board_id: str, actions: Optional[str] = None, actions_entities: Optional[bool] = None, actions_display: Optional[bool] = None, actions_limit: Optional[int] = None, action_fields: Optional[str] = None, action_member_creator_fields: Optional[str] = None, attachments: Optional[bool] = None, attachment_fields: Optional[str] = None, members: Optional[bool] = None, member_fields: Optional[str] = None, members_voted: Optional[bool] = None, member_voted_fields: Optional[str] = None, check_item_states: Optional[bool] = None, check_item_state_fields: Optional[str] = None, checklists: Optional[str] = None, checklist_fields: Optional[str] = None, board: Optional[bool] = None, board_fields: Optional[str] = None, list: Optional[bool] = None, list_fields: Optional[str] = None, stickers: Optional[bool] = None, sticker_fields: Optional[str] = None, fields: Optional[str] = None) -> dict[str, Any] | None

Get a card by id

Get a specific card by its unique id.

delete_card_async async 
delete_card_async(card_id: str, board_id: str) -> dict[str, Any] | None

Delete a card

Delete an existing card from the account.

list_boards_async async 
list_boards_async(filter: Optional[str] = None, fields: Optional[str] = None, actions: Optional[str] = None, actions_entities: Optional[bool] = None, actions_limit: Optional[int] = None, actions_format: Optional[str] = None, actions_since: Optional[str] = None, action_fields: Optional[str] = None, memberships: Optional[str] = None, organization: Optional[bool] = None, organization_fields: Optional[str] = None, lists: Optional[str] = None) -> dict[str, Any] | None

List boards

List the boards matching the specified query parameters.

list_boards_simple_async async 
list_boards_simple_async() -> dict[str, Any] | None

A simple version of the list boards

A simple version of the list boards API call with no parameters to be used by dynamic values.

get_board_async async 
get_board_async(board_id: str, actions: Optional[str] = None, action_entities: Optional[bool] = None, actions_display: Optional[bool] = None, actions_format: Optional[str] = None, actions_since: Optional[str] = None, actions_limit: Optional[int] = None, action_fields: Optional[str] = None, action_member: Optional[bool] = None, action_member_fields: Optional[str] = None, action_member_creator: Optional[bool] = None, action_member_creator_fields: Optional[str] = None, cards: Optional[str] = None, card_fields: Optional[str] = None, card_attachments: Optional[bool] = None, card_attachment_fields: Optional[str] = None, card_checklists: Optional[str] = None, card_stickers: Optional[bool] = None, board_stars: Optional[str] = None, labels: Optional[str] = None, label_fields: Optional[str] = None, labels_limit: Optional[int] = None, lists: Optional[str] = None, list_fields: Optional[str] = None, memberships: Optional[str] = None, memberships_member: Optional[bool] = None, memberships_member_fields: Optional[str] = None, members: Optional[str] = None, member_fields: Optional[str] = None, members_invited: Optional[str] = None, members_invited_fields: Optional[str] = None, checklists: Optional[str] = None, checklist_fields: Optional[str] = None, organization: Optional[bool] = None, organization_fields: Optional[str] = None, organization_memberships: Optional[str] = None, my_perfs: Optional[bool] = None, fields: Optional[str] = None) -> dict[str, Any] | None

Get a board by Id

Get a specific board by its unique identifier.

update_board_async async 
update_board_async(input: UpdateBoard, board_id: str) -> dict[str, Any] | None

Update a board

Update an existing board.

list_lists_async async 
list_lists_async(board_id: str, cards: Optional[str] = None, card_fields: Optional[str] = None, filter: Optional[str] = None, fields: Optional[str] = None) -> dict[str, Any] | None

List the card lists in a board

List the card lists and the cards within the list in a specific board.

list_lists_simple_async async 
list_lists_simple_async(board_id: str) -> dict[str, Any] | None

A simple version of list lists

A simple version of list lists to be used by dynamic values.

get_list_async async 
get_list_async(list_id: str, board_id: str, cards: Optional[str] = None, card_fields: Optional[str] = None, board: Optional[bool] = None, board_fields: Optional[str] = None, fields: Optional[str] = None) -> dict[str, Any] | None

Get list by Id

Get an existing list and the cards in the list by the unique identifier of the list.

update_list_async async 
update_list_async(list_id: str, board_id: str, name: Optional[str] = None, closed: Optional[str] = None, id_board: Optional[str] = None, pos: Optional[str] = None, subscribed: Optional[str] = None) -> dict[str, Any] | None

Update a list

Update an existing list.

get_user_profile_async async 
get_user_profile_async(fields: Optional[str] = None) -> dict[str, Any] | None

Get your User Profile info

Get information about your User Profile

list_teams_async async 
list_teams_async() -> dict[str, Any] | None

List teams you are a member of

The list of teams or organizations the account is a member of.

list_team_members_async async 
list_team_members_async(team_id: str) -> dict[str, Any] | None

List members of a team

List the members in a specific team.

list_board_members_async async 
list_board_members_async(board_id: str) -> dict[str, Any] | None

List members of a board

List the members of a specific board.

list_board_labels_async async 
list_board_labels_async(board_id: str) -> dict[str, Any] | None

List labels of a board

List the labels of a specific board.

get_team_for_board_async async 
get_team_for_board_async(board_id: str) -> dict[str, Any] | None

Get the team for a board

Get the team details for a specific board.

list_card_members_async async 
list_card_members_async(card_id: str, board_id: str) -> dict[str, Any] | None

List members for a card

List the members for a specific card.

list_card_comments_async async 
list_card_comments_async(card_id: str, board_id: str) -> dict[str, Any] | None

List comments for a card

List the comments for a specific card.

add_comment_to_card_async async 
add_comment_to_card_async(input: CommentPost, card_id: str, board_id: str) -> dict[str, Any] | None

Add a comment to a card

Add a comment to a specific card.

add_member_to_card_async async 
add_member_to_card_async(card_id: str, board_id: str, member_id: str) -> dict[str, Any] | None

Add member to a card

Add a member to a specific card.

create_board_async async 
create_board_async(input: CreateBoard) -> dict[str, Any] | None

Create a board

Create a new board with the specified fields.

create_list_async async 
create_list_async(input: CreateList) -> dict[str, Any] | None

Create a list

Create a new list.

close_board_async async 
close_board_async(board_id: str) -> dict[str, Any] | None

Close a board

Set a specific board to closed.

create_card_async async 
create_card_async(input: CreateCard, board_id: str) -> dict[str, Any] | None

Create a card

Creates a new card with the parameters provided.

update_card_async async 
update_card_async(input: UpdateCard, card_id: str, board_id: str) -> dict[str, Any] | None

Update a card

Update an existing card with new parameters.