Class Cards

Hierarchy

Cards

Constructors

constructor

new Cards(client): Cards
Parameters
- client: Client
Returns Cards
- Defined in api/cards.ts:8

Properties

`Private` client

client: Client

Methods

addCardComment

addCardComment<T>(parameters, callback): Promise<void>
Add a new comment to a card
Type Parameters
- T = Action
Parameters
- parameters: AddCardComment
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:704
addCardComment<T>(parameters, callback?): Promise<T>
Add a new comment to a card
Type Parameters
- T = Action
Parameters
- parameters: AddCardComment
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:706

addCardLabel

addCardLabel<T>(parameters, callback): Promise<void>
Add a label to a card
Type Parameters
- T = unknown
Parameters
- parameters: AddCardLabel
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:723
addCardLabel<T>(parameters, callback?): Promise<T>
Add a label to a card
Type Parameters
- T = unknown
Parameters
- parameters: AddCardLabel
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:725

addCardMember

addCardMember<T>(parameters, callback): Promise<void>
Add a member to a card
Type Parameters
- T = unknown
Parameters
- parameters: AddCardMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:739
addCardMember<T>(parameters, callback?): Promise<T>
Add a member to a card
Type Parameters
- T = unknown
Parameters
- parameters: AddCardMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:741

addStickerToCard

addStickerToCard<T>(parameters, callback): Promise<void>
Add a sticker to a card
Type Parameters
- T = unknown
Parameters
- parameters: AddStickerToCard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:543
addStickerToCard<T>(parameters, callback?): Promise<T>
Add a sticker to a card
Type Parameters
- T = unknown
Parameters
- parameters: AddStickerToCard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:545

createCard

createCard<T>(parameters, callback): Promise<void>
Create a new card
Type Parameters
- T = Card
Parameters
- parameters: CreateCard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:11
createCard<T>(parameters, callback?): Promise<T>
Create a new card
Type Parameters
- T = Card
Parameters
- parameters: CreateCard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:13

createCardAttachment

createCardAttachment<T>(parameters, callback): Promise<void>
Create an Attachment to a Card
Type Parameters
- T = Attachment
Parameters
- parameters: CreateCardAttachment
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:179
createCardAttachment<T>(parameters, callback?): Promise<T>
Create an Attachment to a Card
Type Parameters
- T = Attachment
Parameters
- parameters: CreateCardAttachment
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:184

createCardChecklist

createCardChecklist<T>(parameters, callback): Promise<void>
Create a new checklist on a card
Type Parameters
- T = unknown
Parameters
- parameters: CreateCardChecklist
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:335
createCardChecklist<T>(parameters, callback?): Promise<T>
Create a new checklist on a card
Type Parameters
- T = unknown
Parameters
- parameters: CreateCardChecklist
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:340

createCardLabel

createCardLabel<T>(parameters, callback): Promise<void>
Create a new label for the board and add it to the given card.
Type Parameters
- T = unknown
Parameters
- parameters: CreateCardLabel
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:755
createCardLabel<T>(parameters, callback?): Promise<T>
Create a new label for the board and add it to the given card.
Type Parameters
- T = unknown
Parameters
- parameters: CreateCardLabel
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:757

deleteCard

deleteCard<T>(parameters, callback): Promise<void>
Delete a Card
Type Parameters
- T = DeletedCard
Parameters
- parameters: DeleteCard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:106
deleteCard<T>(parameters, callback?): Promise<T>
Delete a Card
Type Parameters
- T = DeletedCard
Parameters
- parameters: DeleteCard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:108

deleteCardAttachment

deleteCardAttachment<T>(parameters, callback): Promise<void>
Delete an Attachment
Type Parameters
- T = DeletedCard
Parameters
- parameters: DeleteCardAttachment
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:250
deleteCardAttachment<T>(parameters, callback?): Promise<T>
Delete an Attachment
Type Parameters
- T = DeletedCard
Parameters
- parameters: DeleteCardAttachment
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:255

deleteCardChecklist

deleteCardChecklist<T>(parameters, callback): Promise<void>
Delete a checklist from a card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardChecklist
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:873
deleteCardChecklist<T>(parameters, callback?): Promise<T>
Delete a checklist from a card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardChecklist
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:878

deleteCardChecklistItem

deleteCardChecklistItem<T>(parameters, callback): Promise<void>
Delete a checklist item
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardChecklistItem
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:406
deleteCardChecklistItem<T>(parameters, callback?): Promise<T>
Delete a checklist item
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardChecklistItem
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:411

deleteCardComment

deleteCardComment<T>(parameters, callback): Promise<void>
Delete a comment
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardComment
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:639
deleteCardComment<T>(parameters, callback?): Promise<T>
Delete a comment
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardComment
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:641

deleteCardLabel

deleteCardLabel<T>(parameters, callback): Promise<void>
Remove a label from a card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardLabel
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:797
deleteCardLabel<T>(parameters, callback?): Promise<T>
Remove a label from a card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardLabel
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:799

deleteCardMember

deleteCardMember<T>(parameters, callback): Promise<void>
Remove a member from a card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:813
deleteCardMember<T>(parameters, callback?): Promise<T>
Remove a member from a card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:815

deleteCardMemberVote

deleteCardMemberVote<T>(parameters, callback): Promise<void>
Remove a member's vote from a card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardMemberVote
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:829
deleteCardMemberVote<T>(parameters, callback?): Promise<T>
Remove a member's vote from a card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardMemberVote
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:834

deleteCardSticker

deleteCardSticker<T>(parameters, callback): Promise<void>
Remove a sticker from the card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardSticker
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:604
deleteCardSticker<T>(parameters, callback?): Promise<T>
Remove a sticker from the card
Type Parameters
- T = unknown
Parameters
- parameters: DeleteCardSticker
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:606

getCard

getCard<T>(parameters, callback): Promise<void>
Get a card by its ID
Type Parameters
- T = Card
Parameters
- parameters: GetCard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:42
getCard<T>(parameters, callback?): Promise<T>
Get a card by its ID
Type Parameters
- T = Card
Parameters
- parameters: GetCard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:44

getCardActions

getCardActions<T>(parameters, callback): Promise<void>
List the Actions on a Card
Type Parameters
- T = Action[]
Parameters
- parameters: GetCardActions
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:135
getCardActions<T>(parameters, callback?): Promise<T>
List the Actions on a Card
Type Parameters
- T = Action[]
Parameters
- parameters: GetCardActions
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:140

getCardAttachment

getCardAttachment<T>(parameters, callback): Promise<void>
Get a specific Attachment on a Card.
Type Parameters
- T = Attachment[]
Parameters
- parameters: GetCardAttachment
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:225
getCardAttachment<T>(parameters, callback?): Promise<T>
Get a specific Attachment on a Card.
Type Parameters
- T = Attachment[]
Parameters
- parameters: GetCardAttachment
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:230

getCardAttachments

getCardAttachments<T>(parameters, callback): Promise<void>
List the attachments on a card
Type Parameters
- T = Attachment[]
Parameters
- parameters: GetCardAttachments
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:157
getCardAttachments<T>(parameters, callback?): Promise<T>
List the attachments on a card
Type Parameters
- T = Attachment[]
Parameters
- parameters: GetCardAttachments
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:162

getCardBoard

getCardBoard<T>(parameters, callback): Promise<void>
Get the board a card is on
Type Parameters
- T = Board
Parameters
- parameters: GetCardBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:272
getCardBoard<T>(parameters, callback?): Promise<T>
Get the board a card is on
Type Parameters
- T = Board
Parameters
- parameters: GetCardBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:274

getCardChecklistItem

getCardChecklistItem<T>(parameters, callback): Promise<void>
Get a specific checkItem on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardChecklistItem
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:359
getCardChecklistItem<T>(parameters, callback?): Promise<T>
Get a specific checkItem on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardChecklistItem
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:364

getCardChecklists

getCardChecklists<T>(parameters, callback): Promise<void>
Get the checklists on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardChecklists
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:313
getCardChecklists<T>(parameters, callback?): Promise<T>
Get the checklists on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardChecklists
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:315

getCardCompletedChecklists

getCardCompletedChecklists<T>(parameters, callback): Promise<void>
Get the completed checklist items on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardCompletedChecklists
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:288
getCardCompletedChecklists<T>(parameters, callback?): Promise<T>
Get the completed checklist items on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardCompletedChecklists
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:293

getCardCustomFields

getCardCustomFields<T>(parameters, callback): Promise<void>
Get the custom field items for a card.
Type Parameters
- T = CustomFieldItems[]
Parameters
- parameters: GetCardCustomFields
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:682
getCardCustomFields<T>(parameters, callback?): Promise<T>
Get the custom field items for a card.
Type Parameters
- T = CustomFieldItems[]
Parameters
- parameters: GetCardCustomFields
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:687

getCardField

getCardField<T>(parameters, callback): Promise<void>
Get a specific property of a card
Type Parameters
- T = Card
Parameters
- parameters: GetCardField
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:122
getCardField<T>(parameters, callback?): Promise<T>
Get a specific property of a card
Type Parameters
- T = Card
Parameters
- parameters: GetCardField
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:124

getCardList

getCardList<T>(parameters, callback): Promise<void>
Get the list a card is in
Type Parameters
- T = List
Parameters
- parameters: GetCardList
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:428
getCardList<T>(parameters, callback?): Promise<T>
Get the list a card is in
Type Parameters
- T = List
Parameters
- parameters: GetCardList
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:430

getCardMembers

getCardMembers<T>(parameters, callback): Promise<void>
Get the members on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardMembers
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:444
getCardMembers<T>(parameters, callback?): Promise<T>
Get the members on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardMembers
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:446

getCardMembersVoted

getCardMembersVoted<T>(parameters, callback): Promise<void>
Get the members who have voted on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardMembersVoted
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:460
getCardMembersVoted<T>(parameters, callback?): Promise<T>
Get the members who have voted on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardMembersVoted
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:465

getCardPluginData

getCardPluginData<T>(parameters, callback): Promise<void>
Get any shared pluginData on a card.
Type Parameters
- T = unknown
Parameters
- parameters: GetCardPluginData
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:507
getCardPluginData<T>(parameters, callback?): Promise<T>
Get any shared pluginData on a card.
Type Parameters
- T = unknown
Parameters
- parameters: GetCardPluginData
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:509

getCardSticker

getCardSticker<T>(parameters, callback): Promise<void>
Get a specific sticker on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardSticker
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:566
getCardSticker<T>(parameters, callback?): Promise<T>
Get a specific sticker on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardSticker
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:568

getCardStickers

getCardStickers<T>(parameters, callback): Promise<void>
Get the stickers on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardStickers
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:523
getCardStickers<T>(parameters, callback?): Promise<T>
Get the stickers on a card
Type Parameters
- T = unknown
Parameters
- parameters: GetCardStickers
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:525

markCardNotificationAsRead

markCardNotificationAsRead<T>(parameters, callback): Promise<void>
Mark notifications about this card as read
Type Parameters
- T = unknown
Parameters
- parameters: MarkCardNotificationAsRead
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:775
markCardNotificationAsRead<T>(parameters, callback?): Promise<T>
Mark notifications about this card as read
Type Parameters
- T = unknown
Parameters
- parameters: MarkCardNotificationAsRead
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:780

updateCard

updateCard<T>(parameters, callback): Promise<void>
Update a card
Type Parameters
- T = Card
Parameters
- parameters: UpdateCard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:75
updateCard<T>(parameters, callback?): Promise<T>
Update a card
Type Parameters
- T = Card
Parameters
- parameters: UpdateCard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:77

updateCardCheckItem

updateCardCheckItem<T>(parameters, callback): Promise<void>
Update an item in a checklist on a card.
Type Parameters
- T = unknown
Parameters
- parameters: UpdateCardCheckItem
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:381
updateCardCheckItem<T>(parameters, callback?): Promise<T>
Update an item in a checklist on a card.
Type Parameters
- T = unknown
Parameters
- parameters: UpdateCardCheckItem
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:386

updateCardChecklistItem

updateCardChecklistItem<T>(parameters, callback): Promise<void>
Update an item in a checklist on a card.
Type Parameters
- T = CheckItem
Parameters
- parameters: UpdateCardChecklistItem
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:848
updateCardChecklistItem<T>(parameters, callback?): Promise<T>
Update an item in a checklist on a card.
Type Parameters
- T = CheckItem
Parameters
- parameters: UpdateCardChecklistItem
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:853

updateCardComment

updateCardComment<T>(parameters, callback): Promise<void>
Update an existing comment
Type Parameters
- T = unknown
Parameters
- parameters: UpdateCardComment
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:620
updateCardComment<T>(parameters, callback?): Promise<T>
Update an existing comment
Type Parameters
- T = unknown
Parameters
- parameters: UpdateCardComment
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:622

updateCardCustomField

updateCardCustomField<T>(parameters, callback): Promise<void>
Setting, updating, and removing the value for a Custom Field on a card. For more details on updating custom fields check out the Getting Started With Custom Fields
Type Parameters
- T = unknown
Parameters
- parameters: UpdateCardCustomField
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:659
updateCardCustomField<T>(parameters, callback?): Promise<T>
Setting, updating, and removing the value for a Custom Field on a card. For more details on updating custom fields check out the Getting Started With Custom Fields
Type Parameters
- T = unknown
Parameters
- parameters: UpdateCardCustomField
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:668

updateCardSticker

updateCardSticker<T>(parameters, callback): Promise<void>
Update a sticker on a card
Type Parameters
- T = unknown
Parameters
- parameters: UpdateCardSticker
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:582
updateCardSticker<T>(parameters, callback?): Promise<T>
Update a sticker on a card
Type Parameters
- T = unknown
Parameters
- parameters: UpdateCardSticker
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:584

voteOnCardForGivenMember

voteOnCardForGivenMember<T>(parameters, callback): Promise<void>
Vote on the card for a given member.
Type Parameters
- T = unknown
Parameters
- parameters: VoteOnCardForGivenMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/cards.ts:482
voteOnCardForGivenMember<T>(parameters, callback?): Promise<T>
Vote on the card for a given member.
Type Parameters
- T = unknown
Parameters
- parameters: VoteOnCardForGivenMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/cards.ts:487

Class Cards

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns Cards

Properties

Private client

Methods

addCardComment

Type Parameters

T = Action

Parameters

parameters: AddCardComment

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = Action

Parameters

parameters: AddCardComment

Optional callback: undefined

Returns Promise<T>

addCardLabel

Type Parameters

T = unknown

Parameters

parameters: AddCardLabel

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: AddCardLabel

Optional callback: undefined

Returns Promise<T>

addCardMember

Type Parameters

T = unknown

Parameters

parameters: AddCardMember

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: AddCardMember

Optional callback: undefined

Returns Promise<T>

addStickerToCard

Type Parameters

T = unknown

Parameters

parameters: AddStickerToCard

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: AddStickerToCard

Optional callback: undefined

Returns Promise<T>

createCard

Type Parameters

T = Card

Parameters

parameters: CreateCard

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = Card

Parameters

parameters: CreateCard

Optional callback: undefined

Returns Promise<T>

createCardAttachment

`Private` client

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined