Types
ApiError(*, error: str, errorCode: int, _other: CatchAll)
error: str
errorCode: int
Block(*, type: BlockType | None = None, parentId: str | None = None, schema: int | None = None, title: str | None = None, fields: dict | None = None, boardId: str | None = None, createAt: int, updateAt: int, deleteAt: int, createdBy: str, modifiedBy: str, id: str, _other: CatchAll)
Bases: ResourceMetadata, BlockBody
boardId: str | None = None
createAt: int
createdBy: str
deleteAt: int
fields: dict | None = None
id: str
modifiedBy: str
parentId: str | None = None
schema: int | None = None
title: str | None = None
updateAt: int
BlockBody(*, type: BlockType | None = None, parentId: str | None = None, schema: int | None = None, title: str | None = None, fields: dict | None = None, boardId: str | None = None)
boardId: str | None = None
fields: dict | None = None
parentId: str | None = None
schema: int | None = None
title: str | None = None
Bases: StrEnum
ATTACHMENT = 'attachment'
CARD = 'card'
CHECKBOX = 'checkbox'
COMMENT = 'comment'
DIVIDER = 'divider'
IMAGE = 'image'
TEXT = 'text'
VIEW = 'view'
Board(*, type: BoardType | None = None, channelId: str | None = None, minimumRole: str | None = None, title: str | None = None, description: str | None = None, icon: str | None = None, showDescription: bool | None = None, isTemplate: bool | None = None, templateVersion: int | None = None, properties: dict[str, str] | None = None, cardProperties: list[Field] | None = None, createAt: int, updateAt: int, deleteAt: int, createdBy: str, modifiedBy: str, id: str, teamId: str, _other: CatchAll)
Bases: ResourceMetadata, BoardBody
channelId: str | None = None
createAt: int
createdBy: str
deleteAt: int
description: str | None = None
icon: str | None = None
id: str
isTemplate: bool | None = None
minimumRole: str | None = None
modifiedBy: str
properties: dict[str, str] | None = None
showDescription: bool | None = None
teamId: str
templateVersion: int | None = None
title: str | None = None
updateAt: int
BoardBody(*, type: BoardType | None = None, channelId: str | None = None, minimumRole: str | None = None, title: str | None = None, description: str | None = None, icon: str | None = None, showDescription: bool | None = None, isTemplate: bool | None = None, templateVersion: int | None = None, properties: dict[str, str] | None = None, cardProperties: list[Field] | None = None)
channelId: str | None = None
description: str | None = None
icon: str | None = None
isTemplate: bool | None = None
minimumRole: str | None = None
properties: dict[str, str] | None = None
showDescription: bool | None = None
templateVersion: int | None = None
title: str | None = None
Bases: StrEnum
Open = 'O'
Private = 'P'
BoardsStatistics(*, board_count: int, card_count: int, _other: CatchAll)
board_count: int
card_count: int
Card(*, title: str | None = None, contentOrder: list[str] | None = None, icon: str | None = None, isTemplate: bool | None = None, properties: dict[str, Any] | None = None, createAt: int, updateAt: int, deleteAt: int, createdBy: str, modifiedBy: str, id: str, boardId: str, _other: CatchAll)
Bases: ResourceMetadata, CardBody
boardId: str
contentOrder: list[str] | None = None
createAt: int
createdBy: str
deleteAt: int
icon: str | None = None
id: str
isTemplate: bool | None = None
modifiedBy: str
properties: dict[str, Any] | None = None
title: str | None = None
updateAt: int
CardBody(*, title: str | None = None, contentOrder: list[str] | None = None, icon: str | None = None, isTemplate: bool | None = None, properties: dict[str, Any] | None = None)
contentOrder: list[str] | None = None
icon: str | None = None
isTemplate: bool | None = None
properties: dict[str, Any] | None = None
title: str | None = None
CardPatch(*, title: str | None = None, contentOrder: list[str] | None = None, icon: str | None = None, updatedProperties: dict[str, Any] | None = None)
contentOrder: list[str] | None = None
icon: str | None = None
title: str | None = None
updatedProperties: dict[str, Any] | None = None
Category(*, name: str, collapsed: bool | None = None, sorting: str | None = None, type: str | None = None, boardMetadata: list[Metadata] | None = None, sortOrder: int | None = None, createAt: int, updateAt: int, deleteAt: int, id: str, userID: str, teamID: str, _other: CatchAll)
Bases: ResourceMetadataTime, CategoryBody
collapsed: bool | None = None
createAt: int
deleteAt: int
id: str
name: str
sortOrder: int | None = None
sorting: str | None = None
teamID: str
type: str | None = None
updateAt: int
userID: str
CategoryBody(*, name: str, collapsed: bool | None = None, sorting: str | None = None, type: str | None = None, boardMetadata: list[Metadata] | None = None, sortOrder: int | None = None)
collapsed: bool | None = None
name: str
sortOrder: int | None = None
sorting: str | None = None
type: str | None = None
Channel(*, id: str, create_at: int, update_at: int, delete_at: int, team_id: str, type: ChannelType, display_name: str, name: str, header: str, purpose: str, last_post_at: int, total_msg_count: int, extra_update_at: int, creator_id: str, scheme_id: str | None, props: dict | None, group_constrained: bool | None, shared: bool | None, total_msg_count_root: int, policy_id: str | None, last_root_post_at: int, _other: CatchAll)
create_at: int
creator_id: str
delete_at: int
display_name: str
extra_update_at: int
group_constrained: bool | None
header: str
id: str
last_post_at: int
last_root_post_at: int
name: str
policy_id: str | None
props: dict | None
purpose: str
scheme_id: str | None
shared: bool | None
team_id: str
total_msg_count: int
total_msg_count_root: int
update_at: int
Bases: StrEnum
Open = 'O'
Private = 'P'
ClientConfig(*, telemetry: bool, telemetryid: str, enablePublicSharedBoards: bool, teammateNameDisplay: bool, featureFlags: dict[str, Literal['true'] | Literal['false']], maxFileSize: int, _other: CatchAll)
enablePublicSharedBoards: bool
featureFlags: dict[str, Literal['true'] | Literal['false']]
maxFileSize: int
teammateNameDisplay: bool
telemetry: bool
telemetryid: str
Field(*, id: str | None = None, name: str, options: list[FieldOption] | None = None, type: str | None = None, _other: CatchAll)
id: str | None = None
name: str
type: str | None = None
FieldOption(*, color: str, id: str, value: str, _other: CatchAll)
color: str
id: str
value: str
FileUploadResponse(*, fileId: str, _other: CatchAll)
fileId: str
BadRequest = 400
Ok = 200
LoginRequest(*, type: Literal['normal'] = 'normal', username: str | None = None, email: str | None = None, password: str, mfa_token: str | None = None, _other: CatchAll)
email: str | None = None
mfa_token: str | None = None
password: str
type: Literal['normal'] = 'normal'
username: str | None = None
Member(*, schemeAdmin: bool | None = None, schemeEditor: bool | None = None, schemeCommenter: bool | None = None, schemeViewer: bool | None = None, boardId: str, userId: str, roles: str, minimumRole: str, synthetic: bool, _other: CatchAll)
Bases: MemberBody
boardId: str
minimumRole: str
roles: str
schemeAdmin: bool | None = None
schemeCommenter: bool | None = None
schemeEditor: bool | None = None
schemeViewer: bool | None = None
synthetic: bool
userId: str
MemberBody(*, schemeAdmin: bool | None = None, schemeEditor: bool | None = None, schemeCommenter: bool | None = None, schemeViewer: bool | None = None)
schemeAdmin: bool | None = None
schemeCommenter: bool | None = None
schemeEditor: bool | None = None
schemeViewer: bool | None = None
Metadata(*, boardID: str, hidden: bool, _other: CatchAll)
boardID: str
hidden: bool
Onboarding(*, teamID: str, boardID: str, _other: CatchAll)
boardID: str
teamID: str
ResourceMetadata(*, createAt: int, updateAt: int, deleteAt: int, createdBy: str, modifiedBy: str)
Bases: ResourceMetadataUsers, ResourceMetadataTime
createAt: int
createdBy: str
deleteAt: int
modifiedBy: str
updateAt: int
ResourceMetadataTime(*, createAt: int, updateAt: int, deleteAt: int)
createAt: int
deleteAt: int
updateAt: int
ResourceMetadataUsers(*, createdBy: str, modifiedBy: str)
createdBy: str
modifiedBy: str
Sharing(*, enabled: bool, token: str, id: str, modifiedBy: str, update_at: int, _other: CatchAll)
Bases: SharingBody
enabled: bool
id: str
modifiedBy: str
token: str
update_at: int
SharingBody(*, enabled: bool | None = None, token: str | None = None)
enabled: bool | None = None
token: str | None = None
Bases: StrEnum
Channel = 'channel'
User = 'user'
Subscription(*, blockType: str, blockId: str, subscriberType: SubscriberType, subscriberId: str, notifiedAt: int, createAt: int, deleteAt: int, _other: CatchAll)
blockId: str
blockType: str
createAt: int
deleteAt: int
notifiedAt: int
subscriberId: str
Team(*, id: str, title: str, signupToken: str, settings: Any | None, modifiedBy: str, updateAt: int, _other: CatchAll)
id: str
modifiedBy: str
settings: Any | None
signupToken: str
title: str
updateAt: int
User(*, id: str, username: str, nickname: str, firstname: str, lastname: str, create_at: int, update_at: int, delete_at: int, is_bot: bool, is_guest: bool, roles: str, _other: CatchAll, permissions: list[str] | None = None)
create_at: int
delete_at: int
firstname: str
id: str
is_bot: bool
is_guest: bool
lastname: str
nickname: str
permissions: list[str] | None = None
roles: str
update_at: int
username: str
UserPreference(*, updatedFields: dict[str, str], deletedFields: list[str], _other: CatchAll)
deletedFields: list[str]
updatedFields: dict[str, str]