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 | Mapping[str, Any]]] = 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 | Mapping[str, Any]] = None, due: Optional[str] = None, short_url: Optional[str] = None, subscribed: Optional[bool] = None, url: Optional[str] = None, checklists: Optional[List[Checklist | Mapping[str, Any]]] = None)

Response for List the cards in a board

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique id of the card.

check_item_states class-attribute instance-attribute

check_item_states: Optional[List[CheckItemState | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'checkItemStates'})

The check item states in the card.

closed class-attribute instance-attribute

closed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dateLastActivity'})

The datetime of last activity on the card.

desc class-attribute instance-attribute

desc: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the card.

id_board class-attribute instance-attribute

id_board: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idMembersVoted'})

The unique Ids of the voting members.

id_short class-attribute instance-attribute

id_short: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idShort'})

The short Id of the card.

id_attachment_cover class-attribute instance-attribute

id_attachment_cover: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idAttachmentCover'})

The unique Id of the attachment cover.

manual_cover_attachment class-attribute instance-attribute

manual_cover_attachment: Optional[bool] = dataclass_field(default=None, kw_only=True, 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]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idLabels'})

A list of label Ids on the card.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the card.

pos class-attribute instance-attribute

pos: Optional[float] = dataclass_field(default=None, kw_only=True)

The position of the card.

short_link class-attribute instance-attribute

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

A short link to the card.

due class-attribute instance-attribute

due: Optional[str] = dataclass_field(default=None, kw_only=True)

The due date of the card.

short_url class-attribute instance-attribute

short_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'shortUrl'})

The short url link to the card.

subscribed class-attribute instance-attribute

subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The full url to the card.

checklists class-attribute instance-attribute

checklists: Optional[List[Checklist | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The set of board checklists.

CardWithChecklists dataclass

CardWithChecklists(*, id: Optional[str] = None, check_item_states: Optional[List[CheckItemState | Mapping[str, Any]]] = 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 | Mapping[str, Any]] = None, due: Optional[str] = None, short_url: Optional[str] = None, subscribed: Optional[bool] = None, url: Optional[str] = None, checklists: Optional[List[Checklist | Mapping[str, Any]]] = None)

Response for Get a card by id

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique id of the card.

check_item_states class-attribute instance-attribute

check_item_states: Optional[List[CheckItemState | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'checkItemStates'})

The check item states in the card.

closed class-attribute instance-attribute

closed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dateLastActivity'})

The datetime of last activity on the card.

desc class-attribute instance-attribute

desc: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the card.

id_board class-attribute instance-attribute

id_board: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idMembersVoted'})

The unique Ids of the voting members.

id_short class-attribute instance-attribute

id_short: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idShort'})

The short Id of the card.

id_attachment_cover class-attribute instance-attribute

id_attachment_cover: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idAttachmentCover'})

The unique Id of the attachment cover.

manual_cover_attachment class-attribute instance-attribute

manual_cover_attachment: Optional[bool] = dataclass_field(default=None, kw_only=True, 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]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idLabels'})

A list of label Ids on the card.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the card.

pos class-attribute instance-attribute

pos: Optional[float] = dataclass_field(default=None, kw_only=True)

The position of the card.

short_link class-attribute instance-attribute

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

A short link to the card.

due class-attribute instance-attribute

due: Optional[str] = dataclass_field(default=None, kw_only=True)

The due date of the card.

short_url class-attribute instance-attribute

short_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'shortUrl'})

The short url link to the card.

subscribed class-attribute instance-attribute

subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The full url to the card.

checklists class-attribute instance-attribute

checklists: Optional[List[Checklist | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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 | Mapping[str, Any]] = None, memberships: Optional[List[Membership | Mapping[str, Any]]] = None, name: Optional[str] = None, pinned: Optional[bool] = None, power_ups: Optional[List[str]] = None, perfs: Optional[Perfs | Mapping[str, Any]] = 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] = dataclass_field(default=None, kw_only=True)

The unique Id of the board.

closed class-attribute instance-attribute

closed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dateLastActivity'})

Date of the last activity on the board.

date_last_view class-attribute instance-attribute

date_last_view: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dateLastView'})

Date of the last time the board is viewed.

desc class-attribute instance-attribute

desc: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the board.

id_organization class-attribute instance-attribute

id_organization: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idOrganization'})

The id of the organization.

invitations class-attribute instance-attribute

invitations: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

The list of invitations on the board.

invited class-attribute instance-attribute

invited: Optional[bool] = dataclass_field(default=None, kw_only=True)

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 | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The set of board memberships.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the board.

pinned class-attribute instance-attribute

pinned: Optional[bool] = dataclass_field(default=None, kw_only=True)

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

power_ups class-attribute instance-attribute

power_ups: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'powerUps'})

The set of power ups on the board.

short_link class-attribute instance-attribute

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

The short link of the board.

short_url class-attribute instance-attribute

short_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'shortUrl'})

The short url to the board.

starred class-attribute instance-attribute

starred: Optional[bool] = dataclass_field(default=None, kw_only=True)

A value determining whether or not the board is starred.

subscribed class-attribute instance-attribute

subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

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 | Mapping[str, Any]] = None, memberships: Optional[List[Membership | Mapping[str, Any]]] = None, name: Optional[str] = None, pinned: Optional[bool] = None, power_ups: Optional[List[str]] = None, perfs: Optional[Perfs | Mapping[str, Any]] = 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 | Mapping[str, Any]]] = None)

Response for Get a board by Id

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique Id of the board.

closed class-attribute instance-attribute

closed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dateLastActivity'})

Date of the last activity on the board.

date_last_view class-attribute instance-attribute

date_last_view: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dateLastView'})

Date of the last time the board is viewed.

desc class-attribute instance-attribute

desc: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the board.

id_organization class-attribute instance-attribute

id_organization: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idOrganization'})

The id of the organization.

invitations class-attribute instance-attribute

invitations: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

The list of invitations on the board.

invited class-attribute instance-attribute

invited: Optional[bool] = dataclass_field(default=None, kw_only=True)

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 | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The set of board memberships.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the board.

pinned class-attribute instance-attribute

pinned: Optional[bool] = dataclass_field(default=None, kw_only=True)

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

power_ups class-attribute instance-attribute

power_ups: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'powerUps'})

The set of power ups on the board.

short_link class-attribute instance-attribute

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

The short link of the board.

short_url class-attribute instance-attribute

short_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'shortUrl'})

The short url to the board.

starred class-attribute instance-attribute

starred: Optional[bool] = dataclass_field(default=None, kw_only=True)

A value determining whether or not the board is starred.

subscribed class-attribute instance-attribute

subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The full url of the board.

checklists class-attribute instance-attribute

checklists: Optional[List[Checklist | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

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 | Mapping[str, Any]]] = None, board: Optional[Board | Mapping[str, Any]] = None)

Response for List the card lists in a board

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique Id of the list.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the list.

closed class-attribute instance-attribute

closed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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

id_board class-attribute instance-attribute

id_board: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idBoard'})

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

pos class-attribute instance-attribute

pos: Optional[float] = dataclass_field(default=None, kw_only=True)

The position of the list.

subscribed class-attribute instance-attribute

subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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 | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The cards inside the list.

CreateListResponse dataclass

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

Response for Update a list

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique Id of the list.

name instance-attribute

name: str

The name of the list.

id_board class-attribute instance-attribute

id_board: str = dataclass_field(metadata={'wire_name': 'idBoard'})

The unique Id of the board the list belongs to.

pos class-attribute instance-attribute

pos: Optional[float] = dataclass_field(default=None, kw_only=True)

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 | Mapping[str, Any]]] = None, web_site: Optional[str] = None, prefs: Optional[TeamPreferences | Mapping[str, Any]] = None)

Response for List teams you are a member of

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the team.

desc class-attribute instance-attribute

desc: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the team.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The display name of the team.

id_boards class-attribute instance-attribute

id_boards: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idBoards'})

The boards assigned to this team.

billable_member_count class-attribute instance-attribute

billable_member_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'billableMemberCount'})

The number of members in this team.

memberships class-attribute instance-attribute

memberships: Optional[List[Membership | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The memberships for this team.

web_site class-attribute instance-attribute

web_site: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The unique Id of the member.

full_name class-attribute instance-attribute

full_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fullName'})

The full name of the member.

username class-attribute instance-attribute

username: Optional[str] = dataclass_field(default=None, kw_only=True)

The username of the member.

initials class-attribute instance-attribute

initials: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The Label Id

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The Label name.

color class-attribute instance-attribute

color: Optional[str] = dataclass_field(default=None, kw_only=True)

The Label color.

Comment dataclass

Comment(*, member_creator: Optional[Member | Mapping[str, Any]] = 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] = dataclass_field(default=None, kw_only=True)

The text of the comment.

date class-attribute instance-attribute

date: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The unique id of the card.

id_short class-attribute instance-attribute

id_short: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idShort'})

The short Id of the card.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the card.

short_link class-attribute instance-attribute

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

A short link to the card.

due class-attribute instance-attribute

due: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idCheckItem'})

ID of the check item.

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Votes'})

The number of votes on the card badges.

viewing_member_voted class-attribute instance-attribute

viewing_member_voted: Optional[bool] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Fogbugz'})

The fogbugz of the badges.

check_items class-attribute instance-attribute

check_items: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckItems'})

The number of check items in the badge.

check_items_checked class-attribute instance-attribute

check_items_checked: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CheckItemsChecked'})

The number of checked check items in the badge.

comments class-attribute instance-attribute

comments: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})

The comments on the badge.

attachments class-attribute instance-attribute

attachments: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attachments'})

The attachments on the badge.

description class-attribute instance-attribute

description: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})

The description of the badge.

due class-attribute instance-attribute

due: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Due'})

The due date of the badge.

UpdateCard dataclass

UpdateCard(name: str, *, 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 instance-attribute

name: str

The updated name of the new card.

desc class-attribute instance-attribute

desc: Optional[str] = dataclass_field(default=None, kw_only=True)

The updated description of the new card.

closed class-attribute instance-attribute

closed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idAttachmentCover'})

The id of the attachment to attach to the card.

id_board class-attribute instance-attribute

id_board: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idBoard'})

The id of the board to attach the card to.

id_list class-attribute instance-attribute

id_list: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idList'})

The id of the list to attach the card to.

pos class-attribute instance-attribute

pos: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The due date of the card.

subscribed class-attribute instance-attribute

subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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

CreateCard dataclass

CreateCard(id_list: str, name: str, *, 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: str = dataclass_field(metadata={'wire_name': 'idList'})

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

name instance-attribute

name: str

The name of the new card.

desc class-attribute instance-attribute

desc: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the new card.

pos class-attribute instance-attribute

pos: Optional[str] = dataclass_field(default=None, kw_only=True)

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]] = dataclass_field(default=None, kw_only=True, 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]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idLabelsArray'})

An array of label Ids to attach to the card.

url_source class-attribute instance-attribute

url_source: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fileSource'})

Source file of the card.

id_card_source class-attribute instance-attribute

id_card_source: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'keepFromSource'})

Properties of the card to copy over from the source.

due class-attribute instance-attribute

due: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The value of the green label.

yellow class-attribute instance-attribute

yellow: Optional[str] = dataclass_field(default=None, kw_only=True)

The value of the yellow label.

orange class-attribute instance-attribute

orange: Optional[str] = dataclass_field(default=None, kw_only=True)

The value of the orange label.

red class-attribute instance-attribute

red: Optional[str] = dataclass_field(default=None, kw_only=True)

The value of the red label.

purple class-attribute instance-attribute

purple: Optional[str] = dataclass_field(default=None, kw_only=True)

The value of the purple label.

blue class-attribute instance-attribute

blue: Optional[str] = dataclass_field(default=None, kw_only=True)

The value of the blue label.

sky class-attribute instance-attribute

sky: Optional[str] = dataclass_field(default=None, kw_only=True)

The value of the sky blue label.

lime class-attribute instance-attribute

lime: Optional[str] = dataclass_field(default=None, kw_only=True)

The value of the lime green label.

pink class-attribute instance-attribute

pink: Optional[str] = dataclass_field(default=None, kw_only=True)

The value of the pink label.

black class-attribute instance-attribute

black: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The unique Id of the membership.

id_member class-attribute instance-attribute

id_member: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idMember'})

The unique Id of the member.

member_type class-attribute instance-attribute

member_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'memberType'})

The type of member.

unconfirmed class-attribute instance-attribute

unconfirmed: Optional[bool] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'permissionLevel'})

The permission level of the object.

voting class-attribute instance-attribute

voting: Optional[str] = dataclass_field(default=None, kw_only=True)

Who can vote on the object.

comments class-attribute instance-attribute

comments: Optional[str] = dataclass_field(default=None, kw_only=True)

Who can comment on the object.

invitations class-attribute instance-attribute

invitations: Optional[str] = dataclass_field(default=None, kw_only=True)

Who can invite people to the object.

self_join class-attribute instance-attribute

self_join: Optional[bool] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The background of the object.

background_color class-attribute instance-attribute

background_color: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'backgroundColor'})

The background color of the object, in hex notation.

background_image class-attribute instance-attribute

background_image: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'backgroundImage'})

The background image of the object.

background_image_scaled class-attribute instance-attribute

background_image_scaled: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'backgroundImageScaled'})

The scaled version of the background image.

background_tile class-attribute instance-attribute

background_tile: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'backgroundTile'})

The background tile of the object.

background_brightness class-attribute instance-attribute

background_brightness: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'backgroundBrightness'})

The brightness of the object background.

can_be_public class-attribute instance-attribute

can_be_public: Optional[bool] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The name of the board.

default_lists class-attribute instance-attribute

default_lists: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'defaultLists'})

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

desc class-attribute instance-attribute

desc: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the board.

id_organization class-attribute instance-attribute

id_organization: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idOrganization'})

The id of the team.

prefs_permission_level class-attribute instance-attribute

prefs_permission_level: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'prefs_permissionLevel'})

The permission level of the board.

prefs_comments class-attribute instance-attribute

prefs_comments: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

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

prefs_card_covers class-attribute instance-attribute

prefs_card_covers: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The background color of the board.

prefs_voting class-attribute instance-attribute

prefs_voting: Optional[str] = dataclass_field(default=None, kw_only=True)

The voting power-up preferences of the board.

prefs_card_aging class-attribute instance-attribute

prefs_card_aging: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'prefs_cardAging'})

The card aging power-up preferences of the board.

enable_calendar class-attribute instance-attribute

enable_calendar: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The unique Id of the webhook.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Brief Description of the webhook

id_model class-attribute instance-attribute

id_model: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callbackURL'})

The callbackURL to receive webhook notifications

active class-attribute instance-attribute

active: Optional[bool] = dataclass_field(default=None, kw_only=True)

Determines whether the webhook is active and sending POST requests.

consecutive_failures class-attribute instance-attribute

consecutive_failures: Optional[float] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The text of the comment.

CreateBoard dataclass

CreateBoard(name: str, *, 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 instance-attribute

name: str

The name of the board.

default_lists class-attribute instance-attribute

default_lists: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'defaultLists'})

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

desc class-attribute instance-attribute

desc: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the board.

id_organization class-attribute instance-attribute

id_organization: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idOrganization'})

The id of the team.

prefs_permission_level class-attribute instance-attribute

prefs_permission_level: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The comment preferences of the board.

prefs_invitations class-attribute instance-attribute

prefs_invitations: Optional[str] = dataclass_field(default=None, kw_only=True)

The invitation preferences of the board.

prefs_card_covers class-attribute instance-attribute

prefs_card_covers: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The background color of the board.

prefs_voting class-attribute instance-attribute

prefs_voting: Optional[str] = dataclass_field(default=None, kw_only=True)

The voting power-up preferences of the board.

prefs_card_aging class-attribute instance-attribute

prefs_card_aging: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'prefs_cardAging'})

The card aging power-up preferences of the board.

enable_calendar class-attribute instance-attribute

enable_calendar: Optional[str] = dataclass_field(default=None, kw_only=True)

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

CreateList dataclass

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

Definition: CreateList

Attributes

name instance-attribute

name: str

The name of the list.

id_board class-attribute instance-attribute

id_board: str = dataclass_field(metadata={'wire_name': 'idBoard'})

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

pos class-attribute instance-attribute

pos: Optional[str] = dataclass_field(default=None, kw_only=True)

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

id_list_source class-attribute instance-attribute

id_list_source: Optional[str] = dataclass_field(default=None, kw_only=True, 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 | Mapping[str, Any]]] = None)

Definition: Checklist

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique Id of the checklist.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the checklist.

pos class-attribute instance-attribute

pos: Optional[int] = dataclass_field(default=None, kw_only=True)

The position of the checklist.

id_board class-attribute instance-attribute

id_board: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idBoard'})

The unique Id of the board.

id_card class-attribute instance-attribute

id_card: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idCard'})

The unique Id of the card.

check_items class-attribute instance-attribute

check_items: Optional[List[Checkitem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The unique Id of the checkitem.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of them checkitem.

name_data class-attribute instance-attribute

name_data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nameData'})

The nameData of them checkitem.

pos class-attribute instance-attribute

pos: Optional[float] = dataclass_field(default=None, kw_only=True)

The position of the checkitem.

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

The state of the checkitem.

due class-attribute instance-attribute

due: Optional[str] = dataclass_field(default=None, kw_only=True)

The due date of the checkitem.

id_member class-attribute instance-attribute

id_member: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idMember'})

The unique Id of the member.

id_checklist class-attribute instance-attribute

id_checklist: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'idChecklist'})

The unique Id of the checklist.

ClientSubscription dataclass

ClientSubscription(notification_u_r_l: str)

Definition: ClientSubscription

Attributes

notification_u_r_l class-attribute instance-attribute

notification_u_r_l: str = dataclass_field(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] = dataclass_field(default=None, kw_only=True)

Id of the subscription

notification_u_r_l class-attribute instance-attribute

notification_u_r_l: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NotificationURL'})

Notification Url

resource class-attribute instance-attribute

resource: Optional[str] = dataclass_field(default=None, kw_only=True)

Resource of the subscription request

notification_type class-attribute instance-attribute

notification_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'notificationType'})

Notification Type

SubscriptionPayload dataclass

SubscriptionPayload(action: Dict[str, Any])

Definition: SubscriptionPayload

Attributes

action instance-attribute

action: Dict[str, Any]

webhook action

TrelloClient

TrelloClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

list_cards

list_cards(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List the cards in a board

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

Returns a single-page Azure Core async collection.

Swagger operation ID: ListCards.

Parameters:

Name	Type	Description	Default
board_id	str	The unique id of the board.	required
actions	Optional[str]	The list the actions to return. Specify 'all' or a comma separated list of valid values.	None
attachments	Optional[bool]	A boolean value (true, false) determining whether or not to show attachments.	None
attachment_fields	Optional[str]	List the attachment fields to return. Specify 'all' or a comma separated list of valid values.	None
stickers	Optional[bool]	A boolean value (true, false) determining whether or not to show stickers.	None
members	Optional[bool]	A boolean value (true, false) determining whether or not to show members.	None
memeber_fields	Optional[str]	List the member fields to return. Specify 'all' or a comma separated list of valid values.	None
check_item_states	Optional[bool]	A boolean value (true, false) determining whether or not to return the card states.	None
checklists	Optional[str]	Specify the checklists to return.	None
limit	Optional[int]	The max number of results to return, between 1 and 1000.	None
since	Optional[str]	Fetch all cards after this date.	None
before	Optional[str]	Fetch all cards before this date.	None
filter	Optional[str]	An option on how to filter the response. The allowed values are 'all', 'closed', 'none', 'open' or 'visible'.	None
fields	Optional[str]	List the card fields to return. Specify 'all' or a comma separated list of valid values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_cards_simple

list_cards_simple(board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

A simple version of the list cards

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

Returns a single-page Azure Core async collection.

Swagger operation ID: ListCardsSimple.

Parameters:

Name	Type	Description	Default
board_id	str	Board Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_card async

get_card(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a card by id

Get a specific card by its unique id.

Swagger operation ID: GetCard.

Parameters:

Name	Type	Description	Default
card_id	str	The id of the card to fetch.	required
board_id	str	The id of the board to fetch cards in.	required
actions	Optional[str]	List the actions to return. Specify 'all' or a comma separated list of valid values.	None
actions_entities	Optional[bool]	A boolean value (true, false) determining whether or not to return action entities.	None
actions_display	Optional[bool]	A boolean value (true, false) determining whether or not to return action displays.	None
actions_limit	Optional[int]	Max number of actions to return.	None
action_fields	Optional[str]	List of action fields to return for each action. Specify 'all' or a comma separated list of valid values.	None
action_member_creator_fields	Optional[str]	List of action member creator fields to return. Specify 'all' or a comma separated list of valid values.	None
attachments	Optional[bool]	A boolean value (true, false) determining whether or not to return attachments.	None
attachment_fields	Optional[str]	List of attachment fields to return for each attachment. Specify 'all' or a comma separated list of valid values.	None
members	Optional[bool]	A boolean value (true, false) determining whether or not to return members.	None
member_fields	Optional[str]	List of member fields to return for each member. Specify 'all' or a comma separated list of valid values.	None
members_voted	Optional[bool]	A boolean value (true, false) determining whether or not to return voted members.	None
member_voted_fields	Optional[str]	List of voted member fields to return for each voted member. Specify 'all' or a comma separated list of valid values.	None
check_item_states	Optional[bool]	A boolean value (true, false) determining whether or not to return card states.	None
check_item_state_fields	Optional[str]	List of state fields to return for each of the card item state. Specify 'all' or a comma separated list of valid values.	None
checklists	Optional[str]	Specify the checklists to return for each card.	None
checklist_fields	Optional[str]	List of checklist fields to return for each checklist. Specify 'all' or a comma separated list of valid values.	None
board	Optional[bool]	A boolean value (true, false) determining whether or not to return the board which the card belongs to.	None
board_fields	Optional[str]	List the board fields to return. Specify 'all' or a comma separated list of valid values.	None
list	Optional[bool]	A boolean value (true, false) determining whether or not to return the list which the card belongs to.	None
list_fields	Optional[str]	List the list fields to return. Specify 'all' or a comma separated list of valid values.	None
stickers	Optional[bool]	A boolean value (true, false) determining whether or not to return the stickers.	None
sticker_fields	Optional[str]	List the sticker fields to return for each sticker. Specify 'all' or a comma separated list of valid values.	None
fields	Optional[str]	List the card fields to return.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_card async

delete_card(card_id: str, board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete a card

Delete an existing card from the account.

Swagger operation ID: DeleteCard.

Parameters:

Name	Type	Description	Default
card_id	str	The id of the card to delete.	required
board_id	str	The id of the board to fetch cards from.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_boards

list_boards(*, 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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List boards

List the boards matching the specified query parameters.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListBoards.

Parameters:

Name	Type	Description	Default
filter	Optional[str]	List filters to apply to board results. Specify 'all' or a comma separated list of valid values.	None
fields	Optional[str]	List the board fields to return. Specify 'all' or a comma separated list of valid values.	None
actions	Optional[str]	List the action fields to return. Specify 'all' or a comma separated list of valid values.	None
actions_entities	Optional[bool]	A boolean value (true, false) determining whether or not to return action entities.	None
actions_limit	Optional[int]	The max number of actions to return.	None
actions_format	Optional[str]	Specify the format of the actions to return. The valid options are 'count', 'list', 'minimal'.	None
actions_since	Optional[str]	Return actions after the specified date.	None
action_fields	Optional[str]	List the fields of the action to return. Specify 'all' or a comma separated list of valid values.	None
memberships	Optional[str]	Specify membership information to return.	None
organization	Optional[bool]	A boolean value (true, false) determining whether or not to return organization information.	None
organization_fields	Optional[str]	List the organization fields to return. Specify 'all' or a comma separated list of valid values.	None
lists	Optional[str]	Specify whether to return lists which belong to the board.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_boards_simple

list_boards_simple(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

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.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListBoardsSimple.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_board async

get_board(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a board by Id

Get a specific board by its unique identifier.

Swagger operation ID: GetBoard.

Parameters:

Name	Type	Description	Default
board_id	str	The unique Id of the board to get.	required
actions	Optional[str]	List the actions to return. Specify 'all' or a comma separated list of valid values.	None
action_entities	Optional[bool]	A boolean value (true, false) determining whether or not to return action entities.	None
actions_display	Optional[bool]	A boolean value (true, false) determining whether or not to return actions display.	None
actions_format	Optional[str]	Specify the format of the actions to return. Valid options are 'count', 'list', 'minimal'.	None
actions_since	Optional[str]	Only return the actions after this date.	None
actions_limit	Optional[int]	Max number of actions to return.	None
action_fields	Optional[str]	List the fields to return with each field. Specify 'all' or a comma separated list of valid values.	None
action_member	Optional[bool]	A boolean value (true, false) determining whether or not to return action members.	None
action_member_fields	Optional[str]	List the member fields to return with each action member. Specify 'all' or a comma separated list of valid values.	None
action_member_creator	Optional[bool]	A boolean value (true, false) determining whether or not to return action member creator.	None
action_member_creator_fields	Optional[str]	List the action member creator fields to return. Specify 'all' or a comma separated list of valid values.	None
cards	Optional[str]	Specify the cards to return. Valid options are 'all', 'closed', 'none', 'open', or 'visible'.	None
card_fields	Optional[str]	List the fields to return for each card. Specify 'all' or a comma separated list of valid values.	None
card_attachments	Optional[bool]	A boolean value (true, false) determining whether or not to return attachments on cards.	None
card_attachment_fields	Optional[str]	List the attachment fields to return for each attachment. Specify 'all' or a comma separated list of valid values.	None
card_checklists	Optional[str]	Specify the checklists to return for each card.	None
card_stickers	Optional[bool]	A boolean value (true, false) determining whether or not to return card stickers.	None
board_stars	Optional[str]	Specify the board stars to return.	None
labels	Optional[str]	Specify the labels to return.	None
label_fields	Optional[str]	List the label fields to return for each label. Specify 'all' or a comma separated list of valid values.	None
labels_limit	Optional[int]	Max number of labels to return.	None
lists	Optional[str]	Specify the lists to return.	None
list_fields	Optional[str]	List the list fields to return for each list. Specify 'all' or a comma separated list of valid values.	None
memberships	Optional[str]	List the memberships to return. Specify 'all' or a comma separated list of valid values.	None
memberships_member	Optional[bool]	A boolean value (true, false) determining whether or not to return membership members.	None
memberships_member_fields	Optional[str]	List the member fields to return for each membership member. Specify 'all' or a comma separated list of valid values.	None
members	Optional[str]	List the members to return. Specify 'all' or a comma separated list of valid values.	None
member_fields	Optional[str]	List the member fields to return for each member. Specify 'all' or a comma separated list of valid values.	None
members_invited	Optional[str]	Specify the invited members to return.	None
members_invited_fields	Optional[str]	List the fields to return for each. Specify 'all' or a comma separated list of valid values.	None
checklists	Optional[str]	Specify the checklists to return.	None
checklist_fields	Optional[str]	List the checklist fields to return for each checklist. Specify 'all' or a comma separated list of valid values.	None
organization	Optional[bool]	A boolean value (true, false) determining whether or not to return the organization information.	None
organization_fields	Optional[str]	List the organization fields to return for each organization. Specify 'all' or a comma separated list of valid values.	None
organization_memberships	Optional[str]	List the organization memberships to return. Specify 'all' or a comma separated list of valid values.	None
my_perfs	Optional[bool]	A boolean value (true, false) determining whether or not to return my perfs.	None
fields	Optional[str]	List the fields to return. Specify 'all' or a comma separated list of valid values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_board async

update_board(input: UpdateBoard | Mapping[str, Any], board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a board

Update an existing board.

Swagger operation ID: UpdateBoard.

Parameters:

Name	Type	Description	Default
input	UpdateBoard | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
board_id	str	The unique identifier of the board to update.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_lists

list_lists(board_id: str, *, cards: Optional[str] = None, card_fields: Optional[str] = None, filter: Optional[str] = None, fields: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List the card lists in a board

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

Returns a single-page Azure Core async collection.

Swagger operation ID: ListLists.

Parameters:

Name	Type	Description	Default
board_id	str	The unique id of the board to fetch lists.	required
cards	Optional[str]	Specify the cards to return.	None
card_fields	Optional[str]	List the card fields to return from. Specify 'all' or a comma separated list of valid values.	None
filter	Optional[str]	Specify the filter property for lists. Valid options are 'all, 'closed', 'none', or 'open'.	None
fields	Optional[str]	List the fields to return. Specify 'all' or a comma separated list of valid values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_lists_simple

list_lists_simple(board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

A simple version of list lists

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

Returns a single-page Azure Core async collection.

Swagger operation ID: ListListsSimple.

Parameters:

Name	Type	Description	Default
board_id	str	Unique Id of the board to fetch lists.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_list async

get_list(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.

Swagger operation ID: GetList.

Parameters:

Name	Type	Description	Default
list_id	str	The unique Id of the list to fetch.	required
board_id	str	The unique Id of the board to fetch the lists from.	required
cards	Optional[str]	Specify the cards to return.	None
card_fields	Optional[str]	List the card fields to return for each card. Specify 'all' or a comma separated list of valid values.	None
board	Optional[bool]	A boolean value (true, false) determining whether or not to return board information.	None
board_fields	Optional[str]	List the board fields to return. Specify 'all' or a comma separated list of valid values.	None
fields	Optional[str]	List the list fields to return. Specify 'all' or a comma separated list of valid values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_list async

update_list(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a list

Update an existing list.

Swagger operation ID: UpdateList.

Parameters:

Name	Type	Description	Default
list_id	str	The unique id of the list to update.	required
board_id	str	The unique id of the board the list is on.	required
name	Optional[str]	The new list name.	None
closed	Optional[str]	A string (true, false) determining whether or not to close the list.	None
id_board	Optional[str]	The unique id of the board to move the list to.	None
pos	Optional[str]	The list position (top, bottom, or number).	None
subscribed	Optional[str]	A boolean value (true, false) determining whether or not to subscribe to the list.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_user_profile async

get_user_profile(*, fields: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get your User Profile info

Get information about your User Profile

Swagger operation ID: GetUserProfile.

Parameters:

Name	Type	Description	Default
fields	Optional[str]	List the fields to return. Specify 'all' or a comma separated list of valid values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_teams

list_teams(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List teams you are a member of

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

Returns a single-page Azure Core async collection.

Swagger operation ID: ListTeams.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_team_members

list_team_members(team_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List members of a team

List the members in a specific team.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListTeamMembers.

Parameters:

Name	Type	Description	Default
team_id	str	The unique Id of the team.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_board_members

list_board_members(board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List members of a board

List the members of a specific board.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListBoardMembers.

Parameters:

Name	Type	Description	Default
board_id	str	The unique Id of the board.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_board_labels

list_board_labels(board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List labels of a board

List the labels of a specific board.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListBoardLabels.

Parameters:

Name	Type	Description	Default
board_id	str	The unique Id of the board.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_team_for_board async

get_team_for_board(board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get the team for a board

Get the team details for a specific board.

Swagger operation ID: GetTeamForBoard.

Parameters:

Name	Type	Description	Default
board_id	str	The unique Id of the board to fetch team.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_card_members

list_card_members(card_id: str, board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List members for a card

List the members for a specific card.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListCardMembers.

Parameters:

Name	Type	Description	Default
card_id	str	The unique id of the card.	required
board_id	str	The unique id of the board to look for cards on.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_card_comments

list_card_comments(card_id: str, board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List comments for a card

List the comments for a specific card.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListCardComments.

Parameters:

Name	Type	Description	Default
card_id	str	The unique id of the card.	required
board_id	str	The unique id of the board to look for comments on.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_comment_to_card async

add_comment_to_card(input: CommentPost | Mapping[str, Any], card_id: str, board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add a comment to a card

Add a comment to a specific card.

Swagger operation ID: AddCommentToCard.

Parameters:

Name	Type	Description	Default
input	CommentPost | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
card_id	str	The unique id of the card.	required
board_id	str	The unique id of the board to add a comment to.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_member_to_card async

add_member_to_card(card_id: str, board_id: str, member_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add member to a card

Add a member to a specific card.

Swagger operation ID: AddMemberToCard.

Parameters:

Name	Type	Description	Default
card_id	str	The unique identifier of the card to add a member to.	required
board_id	str	The unique id of the board the card is on.	required
member_id	str	The member id or username to add to the card.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_board async

create_board(input: CreateBoard | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a board

Create a new board with the specified fields.

Swagger operation ID: CreateBoard.

Parameters:

Name	Type	Description	Default
input	CreateBoard | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_list async

create_list(input: CreateList | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a list

Create a new list.

Swagger operation ID: CreateList.

Parameters:

Name	Type	Description	Default
input	CreateList | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

close_board async

close_board(board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Close a board

Set a specific board to closed.

Swagger operation ID: CloseBoard.

Parameters:

Name	Type	Description	Default
board_id	str	The unique id of the board to close.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_card async

create_card(input: CreateCard | Mapping[str, Any], board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a card

Creates a new card with the parameters provided.

Swagger operation ID: CreateCard_V2.

Parameters:

Name	Type	Description	Default
input	CreateCard | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
board_id	str	The id of the board to create the card in.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_card async

update_card(input: UpdateCard | Mapping[str, Any], card_id: str, board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a card

Update an existing card with new parameters.

Swagger operation ID: UpdateCard_V2.

Parameters:

Name	Type	Description	Default
input	UpdateCard | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
card_id	str	The id of the card to update.	required
board_id	str	The id of the board to fetch cards from.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.