Trello - Documentation

Constructor

new Trello(key, token)

Description:

Create an instance of Trello

Source:

trello.js, line 8

Parameters:

Name	Type	Description
`key`	string	The API key for your Trello account.
`token`	string	The API token for your Trello account.

Methods

(async) Batch(urls) → {Promise.<*>}

Description:

Batch requests

Source:

api/Batch.js, line 14

Parameters:

Name	Type	Description
`urls`

Returns:

Type: Promise.<*>

(async) CreateList(name, idBoard, options) → {Promise.<*>}

Description:

Create a list on a board.

Source:

api/Lists.js, line 70

Parameters:

Name	Type	Description
`name`	string
`idBoard`	string
`options`	Object	{idListSource, pos}

Returns:

Type: Promise.<*>

(async) addBoardMember(boardId, memberId, type, options) → {Promise.<*>}

Description:

Add a member to a board by his id.

Source:

api/Boards.js, line 415

Parameters:

Name	Type	Description
`boardId`	string
`memberId`	string
`type`	string
`options`	Object	{allowBillableGuest}

Returns:

Type: Promise.<*>

(async) addCardComment(idCard, text) → {Promise.<*>}

Description:

Add comment to card by id.

Source:

api/Cards.js, line 755

Parameters:

Name	Type	Description
`idCard`	string
`text`	string

Returns:

Type: Promise.<*>

(async) addCardLabel(idCard, options) → {Promise.<*>}

Description:

Add label to card by id.

Source:

api/Cards.js, line 771

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{value}

Returns:

Type: Promise.<*>

(async) addCardMember(idCard, options) → {Promise.<*>}

Description:

Add member to card by id.

Source:

api/Cards.js, line 795

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{value}

Returns:

Type: Promise.<*>

(async) addCardMemberVote(idCard) → {Promise.<*>}

Description:

Add member voted on a card by id.

Source:

api/Cards.js, line 534

Parameters:

Name	Type	Description
`idCard`	string

Returns:

Type: Promise.<*>

(async) addCardSticker(idCard, image, top, left, zIndex, options) → {Promise.<*>}

Description:

Add card sticker by id.

Source:

api/Cards.js, line 594

Parameters:

Name	Type	Description
`idCard`	string
`image`
`top`
`left`
`zIndex`
`options`	Object	{rotate}

Returns:

Type: Promise.<*>

(async) archiveListCards(idList) → {Promise.<*>}

Description:

Archive card of a list by id.

Source:

api/Lists.js, line 94

Parameters:

Name	Type	Description
`idList`	string

Returns:

Type: Promise.<*>

(async) archiveOrUnarchiveList(idList, options) → {Promise.<*>}

Description:

Achive or unarchive list by id.

Source:

api/Lists.js, line 127

Parameters:

Name	Type	Description
`idList`	string
`options`	Object	{value}

Returns:

Type: Promise.<*>

(async) bulkAcceptEnterpriseOrganization(idEntreprise, idOrganizations) → {Promise.<*>}

Description:

Bulk Accept Enterprise Organization.

Source:

api/Enterprises.js, line 421

Parameters:

Name	Type	Description
`idEntreprise`	string
`idOrganizations`	Array.<Organization>

Returns:

Type: Promise.<*>

(async) createActionReaction(idAction, options) → {Promise.<*>}

Description:

Create a reaction on the action.

Source:

api/Actions.js, line 285

Parameters:

Name	Type	Description
`idAction`	string
`options`	Object	{shortName, skinVariation, native, unified}

Returns:

Type: Promise.<*>

(async) createBoard(name, options) → {Promise.<*>}

Description:

Create a Board

Source:

api/Boards.js, line 595

Parameters:

Name	Type	Description
`name`	string
`options`	Object	{desc, idOrganization, idBoardSource, keepFromSource, powerUps, prefs_permissionLevel, prefs_voting, prefs_comments, prefs_invitations, prefs_selfJoin, prefs_cardCovers, prefs_background, prefs_cardAging

Returns:

Type: Promise.<*>

(async) createBoardCalendarKey(boardId) → {Promise.<*>}

Description:

Create a Board Calendar Key

Source:

api/Boards.js, line 631

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) createBoardEmailKey(boardId) → {Promise.<*>}

Description:

Create a Board Email Key

Source:

api/Boards.js, line 646

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) createBoardLabel(boardId, options) → {Promise.<*>}

Description:

Create a Label for a Board by id.

Source:

api/Boards.js, line 274

Parameters:

Name	Type	Description
`boardId`	string
`options`	Object	{name, color}

Returns:

Type: Promise.<*>

(async) createBoardList(boardId, name, options) → {Promise.<*>}

Description:

Create a List for a Board by id.

Source:

api/Boards.js, line 330

Parameters:

Name	Type	Description
`boardId`	string
`name`	string
`options`	Object	{pos}

Returns:

Type: Promise.<*>

(async) createBoardStar(idMember, idBoard, pos) → {Promise.<*>}

Description:

Create member board star by id.

Source:

api/Members.js, line 257

Parameters:

Name	Type	Description
`idMember`	string
`idBoard`	string
`pos`	string

Returns:

Type: Promise.<*>

(async) createBoardTag(boardId, value) → {Promise.<*>}

Description:

Create a board tag

Source:

api/Boards.js, line 663

Parameters:

Name	Type	Description
`boardId`	string
`value`	string

Returns:

Type: Promise.<*>

(async) createCard(idList, options) → {Promise.<*>}

Description:

Create a card by id list.

Source:

api/Cards.js, line 14

Parameters:

Name	Type	Description
`idList`	string
`options`	Object	{name, desc, pos, due, start, dueComplete, idList, idMembers, idLabels, urlSource, fileSource, mimeType, idCardSource, keepFromSource, address, locationName, coordinates}

Returns:

Type: Promise.<*>

(async) createCardAttachment(idCard, options) → {Promise.<*>}

Description:

Create card attachment by id.

Source:

api/Cards.js, line 214

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{name, mimeType, file, setCover, url}

Returns:

Type: Promise.<*>

(async) createCardChecklist(idCard, options) → {Promise.<*>}

Description:

Create card checklist.

Source:

api/Cards.js, line 363

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{name, idChecklistSource, pos}

Returns:

Type: Promise.<*>

(async) createCardNewLabel(idCard, color, options) → {Promise.<*>}

Description:

Create new label for card by id.

Source:

api/Cards.js, line 821

Parameters:

Name	Type	Description
`idCard`	string
`color`	string
`options`	Object	{name}

Returns:

Type: Promise.<*>

(async) createChecklist(idCard, options) → {Promise.<*>}

Description:

Create a checklist by id board.

Source:

api/Checklists.js, line 14

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{name, idChecklistSource, pos}

Returns:

Type: Promise.<*>

(async) createChecklistCheckItem(idChecklist, name, options) → {Promise.<*>}

Description:

Create checklist checkItem by id.

Source:

api/Checklists.js, line 210

Parameters:

Name	Type	Description
`idChecklist`	string
`name`	string
`options`	Object	{pos, checked, due, dueReminder, idMember}

Returns:

Type: Promise.<*>

(async) createCustomField(idModel, modelType, name, type, pos, options) → {Promise.<*>}

Description:

Create custom field.

Source:

api/CustomFields.js, line 18

Parameters:

Name	Type	Description
`idModel`	string
`modelType`	string
`name`	string
`type`	string
`pos`	string
`options`	Object	{options, display/cardFront}

Returns:

Type: Promise.<*>

(async) createCustomFieldOption(idCustomField) → {Promise.<*>}

Description:

Create custom field option.

Source:

api/CustomFields.js, line 115

Parameters:

Name	Type	Description
`idCustomField`	string

Returns:

Type: Promise.<*>

(async) createEnterpriseAuthToken(idEntreprise, options) → {Promise.<*>}

Description:

Get Enterprise authentication token.

Source:

api/Enterprises.js, line 286

Parameters:

Name	Type	Description
`idEntreprise`	string
`options`	Object	{expiration}

Returns:

Type: Promise.<*>

(async) createLabel(idBoard, name, color) → {Promise.<*>}

Description:

Create label.

Source:

api/Labels.js, line 99

Parameters:

Name	Type	Description
`idBoard`	string
`name`	string
`color`	string

Returns:

Type: Promise.<*>

(async) createMemberAvatar(idMember, file) → {Promise.<*>}

Description:

Create member avatar.

Source:

api/Members.js, line 862

Parameters:

Name	Type	Description
`idMember`	string
`file`

Returns:

Type: Promise.<*>

(async) createMemberCustomSticker(idMember, file) → {Promise.<*>}

Description:

Create new custom sticker for a member by id.

Source:

api/Members.js, line 599

Parameters:

Name	Type	Description
`idMember`	string
`file`

Returns:

Type: Promise.<*>

(async) createMemberNewCustomBoardBackground(idMember, file) → {Promise.<*>}

Description:

Create new custom board background for a member by id.

Source:

api/Members.js, line 425

Parameters:

Name	Type	Description
`idMember`	string
`file`

Returns:

Type: Promise.<*>

(async) createMemberNewCustomEmoji(idMember, file, name) → {Promise.<*>}

Description:

Create new custom emoji for a member by id.

Source:

api/Members.js, line 516

Parameters:

Name	Type	Description
`idMember`	string
`file`
`name`	string

Returns:

Type: Promise.<*>

(async) createMemberSavedSearch(idMember, name, query, pos) → {Promise.<*>}

Description:

Create Member saved search.

Source:

api/Members.js, line 761

Parameters:

Name	Type	Description
`idMember`	string
`name`	string
`query`
`pos`	string

Returns:

Type: Promise.<*>

(async) createOrganization(displayName, options) → {Promise.<*>}

Description:

Create an organization

Source:

api/Organizations.js, line 15

Parameters:

Name	Type	Description
`displayName`	string
`options`	string	{desc, name, website}

Returns:

Type: Promise.<*>

(async) createOrganizationExport(idOrganization, options) → {Promise.<*>}

Description:

Create organization export by id.

Source:

api/Organizations.js, line 180

Parameters:

Name	Type	Description
`idOrganization`	string
`options`	Object	{attachments}

Returns:

Type: Promise.<*>

(async) createOrganizationTag(idOrganization) → {Promise.<*>}

Description:

Create organization tag by id.

Source:

api/Organizations.js, line 328

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) createPluginListing(idPlugin, options) → {Promise.<*>}

Description:

create plugin listing by id

Source:

api/Plugins.js, line 45

Parameters:

Name	Type	Description
`idPlugin`	string
`options`	Object

Returns:

Type: Promise.<*>

(async) createTokenWebhook(idToken, callbackURL, idModel, options) → {Promise.<*>}

Description:

Create token webhook by id Token.

Source:

api/Tokens.js, line 82

Parameters:

Name	Type	Description
`idToken`	string
`callbackURL`
`idModel`	string
`options`	Object	{description}

Returns:

Type: Promise.<*>

createWebhook(idModel, callbackURL, options) → {Promise.<*>}

Description:

Create webhook by id model.

Source:

api/Webhooks.js, line 12

Parameters:

Name	Type	Description
`idModel`	string
`callbackURL`
`options`	Object	{description, active}

Returns:

Type: Promise.<*>

(async) deactivateEnterpriseMember(idEntreprise, idMember, value, options) → {Promise.<*>}

Description:

Deactivate Enterprise Member.

Source:

api/Enterprises.js, line 346

Parameters:

Name	Type	Description
`idEntreprise`	string
`idMember`	string
`value`	string
`options`	Object	{fields, organization_fields, board_fields}

Returns:

Type: Promise.<*>

(async) deactivateORreactivateOrganizationMember(idOrganization, idMember, value) → {Promise.<*>}

Description:

Deactivate or reactivate organization member by id.

Source:

api/Organizations.js, line 378

Parameters:

Name	Type	Description
`idOrganization`	string
`idMember`	string
`value`	string

Returns:

Type: Promise.<*>

(async) declineEnterpriseJoinRequests(idEntreprise, idOrganizations) → {Promise.<*>}

Description:

Decline Enterprise Join Requests.

Source:

api/Enterprises.js, line 215

Parameters:

Name	Type	Description
`idEntreprise`	string
`idOrganizations`	Array.<Organization>

Returns:

Type: Promise.<*>

(async) deleteAction(idAction) → {Promise.<*>}

Description:

Delete an action by ID.

Source:

api/Actions.js, line 62

Parameters:

Name	Type	Description
`idAction`	string

Returns:

Type: Promise.<*>

(async) deleteActionReactionsId(idAction, idReaction) → {Promise.<*>}

Description:

Delete the action's reaction by Id.

Source:

api/Actions.js, line 341

Parameters:

Name	Type	Description
`idAction`	string
`idReaction`	string

Returns:

Type: Promise.<*>

(async) deleteBoard(boardId) → {Promise.<*>}

Description:

Delete Board by id.

Source:

api/Boards.js, line 89

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) deleteBoardStar(idMember, idStar) → {Promise.<*>}

Description:

Delete member board star by id.

Source:

api/Members.js, line 315

Parameters:

Name	Type	Description
`idMember`	string
`idStar`	string

Returns:

Type: Promise.<*>

(async) deleteCard(idCard) → {Promise.<*>}

Description:

Delete card by id.

Source:

api/Cards.js, line 130

Parameters:

Name	Type	Description
`idCard`	string

Returns:

Type: Promise.<*>

(async) deleteCardAttachment(idCard, idAttachment) → {Promise.<*>}

Description:

Delete card attachment by id.

Source:

api/Cards.js, line 269

Parameters:

Name	Type	Description
`idCard`	string
`idAttachment`	string

Returns:

Type: Promise.<*>

(async) deleteCardCheckItem(idCard, idCheckItem) → {Promise.<*>}

Description:

Delete card checkitem by id.

Source:

api/Cards.js, line 444

Parameters:

Name	Type	Description
`idCard`	string
`idCheckItem`	string

Returns:

Type: Promise.<*>

(async) deleteCardChecklist(idCard, idChecklist) → {Promise.<*>}

Description:

Delete card check item on checklist by id.

Source:

api/Cards.js, line 936

Parameters:

Name	Type	Description
`idCard`	string
`idChecklist`	string

Returns:

Type: Promise.<*>

(async) deleteCardComment(idCard, idAction) → {Promise.<*>}

Description:

Delete Card comment action by id.

Source:

api/Cards.js, line 708

Parameters:

Name	Type	Description
`idCard`	string
`idAction`	string

Returns:

Type: Promise.<*>

(async) deleteCardSticker(idCard, idSticker) → {Promise.<*>}

Description:

Delete card sticker by id.

Source:

api/Cards.js, line 675

Parameters:

Name	Type	Description
`idCard`	string
`idSticker`	string

Returns:

Type: Promise.<*>

(async) deleteChecklist(idChecklist) → {Promise.<*>}

Description:

Delete checklist by id.

Source:

api/Checklists.js, line 94

Parameters:

Name	Type	Description
`idChecklist`	string

Returns:

Type: Promise.<*>

(async) deleteChecklistCheckItem(idChecklist, idCheckItem) → {Promise.<*>}

Description:

delete checklist checkItem by id.

Source:

api/Checklists.js, line 263

Parameters:

Name	Type	Description
`idChecklist`	string
`idCheckItem`	string

Returns:

Type: Promise.<*>

(async) deleteCustomBoardBackgroundMember(idMember, idBoardBackground) → {Promise.<*>}

Description:

Delete Custom Board Background Member by id.

Source:

api/Members.js, line 484

Parameters:

Name	Type	Description
`idMember`	string
`idBoardBackground`	string

Returns:

Type: Promise.<*>

(async) deleteCustomField(idCustomField) → {Promise.<*>}

Description:

Delete custom field.

Source:

api/CustomFields.js, line 85

Parameters:

Name	Type	Description
`idCustomField`	string

Returns:

Type: Promise.<*>

(async) deleteCustomFieldOption(idCustomField, idOption) → {Promise.<*>}

Description:

Delete custom field option by id.

Source:

api/CustomFields.js, line 147

Parameters:

Name	Type	Description
`idCustomField`	string
`idOption`	string

Returns:

Type: Promise.<*>

(async) deleteDomainRestriction(idOrganization) → {Promise.<*>}

Description:

Delete domain restriction by id.

Source:

api/Organizations.js, line 464

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) deleteEnterpriseOrganization(idEntreprise, idOrganization) → {Promise.<*>}

Description:

Delete Enterprise Organization.

Source:

api/Enterprises.js, line 405

Parameters:

Name	Type	Description
`idEntreprise`	string
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) deleteLabel(idLabel) → {Promise.<*>}

Description:

Delete label by id.

Source:

api/Labels.js, line 65

Parameters:

Name	Type	Description
`idLabel`	string

Returns:

Type: Promise.<*>

(async) deleteMemberCustomBoardBackground(idMember, idBoardBackground) → {Promise.<*>}

Description:

Delete member custom board background by id.

Source:

api/Members.js, line 225

Parameters:

Name	Type	Description
`idMember`	string
`idBoardBackground`	string

Returns:

Type: Promise.<*>

(async) deleteMemberCustomSticker(idMember, idSticker) → {Promise.<*>}

Description:

Delete Custom Sticker of a member by id.

Source:

api/Members.js, line 641

Parameters:

Name	Type	Description
`idMember`	string
`idSticker`	string

Returns:

Type: Promise.<*>

(async) deleteMemberSavedSearch(idMember, idSearch) → {Promise.<*>}

Description:

Delete Member saved search.

Source:

api/Members.js, line 821

Parameters:

Name	Type	Description
`idMember`	string
`idSearch`	string

Returns:

Type: Promise.<*>

(async) deleteOrganization(idOrganization) → {Promise.<*>}

Description:

Delete an organization by id.

Source:

api/Organizations.js, line 92

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) deleteOrganizationLogo(idOrganization) → {Promise.<*>}

Description:

Delete organization logo by id.

Source:

api/Organizations.js, line 418

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) deleteOrganizationTag(idOrganization, idTag) → {Promise.<*>}

Description:

Delete organization tag by id.

Source:

api/Organizations.js, line 480

Parameters:

Name	Type	Description
`idOrganization`	string
`idTag`	string

Returns:

Type: Promise.<*>

(async) deleteToken(idToken) → {Promise.<*>}

Description:

Delete token by Id Token.

Source:

api/Tokens.js, line 166

Parameters:

Name	Type	Description
`idToken`	string

Returns:

Type: Promise.<*>

(async) deleteWebhook(idWebhook) → {Promise.<*>}

Description:

Delete webhook by id.

Source:

api/Webhooks.js, line 80

Parameters:

Name	Type	Description
`idWebhook`	string

Returns:

Type: Promise.<*>

(async) deleteWebhookCreatedByToken(idToken, idWebhook) → {Promise.<*>}

Description:

Delete webhook created by token by Id Token and Id Webhook.

Source:

api/Tokens.js, line 151

Parameters:

Name	Type	Description
`idToken`	string
`idWebhook`	string

Returns:

Type: Promise.<*>

(async) dismissMemberMessage(idMember, value) → {Promise.<*>}

Description:

Dismiss member message.

Source:

api/Members.js, line 878

Parameters:

Name	Type	Description
`idMember`	string
`value`	string

Returns:

Type: Promise.<*>

(async) getAction(idAction, options) → {promise.<*>}

Description:

Get an action by ID.

Source:

api/Actions.js, line 15

Parameters:

Name	Type	Description
`idAction`	string	The ID of the action.
`options`	Object	{display, entities, fields, member, member_fields, memberCreator, memberCreator_fields}

Returns:

Type: promise.<*>

(async) getActionBoard(idAction, options) → {Promise.<*>}

Description:

Get the action's board.

Source:

api/Actions.js, line 94

Parameters:

Name	Type	Description
`idAction`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getActionCard(idAction, options) → {Promise.<*>}

Description:

Get the action's card.

Source:

api/Actions.js, line 119

Parameters:

Name	Type	Description
`idAction`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getActionList(idAction, options) → {Promise.<Object>}

Description:

Get the action's List.

Source:

api/Actions.js, line 144

Parameters:

Name	Type	Description
`idAction`	string
`options`	Object	{fields}

Returns:

Type: Promise.<Object>

(async) getActionMember(idAction, options) → {Promise.<Object>}

Description:

Get the action's member.

Source:

api/Actions.js, line 169

Parameters:

Name	Type	Description
`idAction`	string
`options`	Object	{fields}

Returns:

Type: Promise.<Object>

(async) getActionMemberCreator(idAction, options) → {Promise.<*>}

Description:

Get the action's member creator.

Source:

api/Actions.js, line 194

Parameters:

Name	Type	Description
`idAction`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getActionOrganization(idAction, options) → {Promise.<*>}

Description:

Get the action's organization.

Source:

api/Actions.js, line 219

Parameters:

Name	Type	Description
`idAction`	string
`options`	object	{fields}

Returns:

Type: Promise.<*>

(async) getActionReactions(idAction, options) → {Promise.<*>}

Description:

Get the action's reactions.

Source:

api/Actions.js, line 260

Parameters:

Name	Type	Description
`idAction`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getActionReactionsId(idAction, idReaction, options) → {Promise.<*>}

Description:

Get the action's reaction by Id.

Source:

api/Actions.js, line 314

Parameters:

Name	Type	Description
`idAction`	string
`idReaction`	string
`options`	Object	{member, emoji}

Returns:

Type: Promise.<*>

(async) getActionSpecifiedField(idAction, field) → {Promise.<*>}

Description:

Get the action's board for a specified field.

Source:

api/Actions.js, line 78

Parameters:

Name	Type	Description
`idAction`	string
`field`	string

Returns:

Type: Promise.<*>

(async) getActionSummaryReactions(idAction) → {Promise.<*>}

Description:

Get the action's reaction summary.

Source:

api/Actions.js, line 356

Parameters:

Name	Type	Description
`idAction`	string

Returns:

Type: Promise.<*>

(async) getApplicationData(applicationId) → {Promise.<*>}

Description:

Get application data

Source:

api/Applications.js, line 14

Parameters:

Name	Type	Description
`applicationId`	string

Returns:

Type: Promise.<*>

(async) getBoard(boardId) → {Promise.<*>}

Description:

Get Board by id.

Source:

api/Boards.js, line 29

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) getBoardActions(boardId, options) → {Promise.<*>}

Description:

Get Board Actions by id.

Source:

api/Boards.js, line 121

Parameters:

Name	Type	Description
`boardId`	string
`options`	Object	{filter}

Returns:

Type: Promise.<*>

(async) getBoardCard(boardId, idCard) → {Promise.<*>}

Description:

Get Board Cards by id.

Source:

api/Boards.js, line 146

Parameters:

Name	Type	Description
`boardId`	string
`idCard`	string

Returns:

Type: Promise.<*>

(async) getBoardCards(boardId) → {Promise.<*>}

Description:

Get Card of a Board by id.

Source:

api/Boards.js, line 201

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) getBoardChecklists(boardId) → {Promise.<*>}

Description:

Get Board Checklists by id.

Source:

api/Boards.js, line 186

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) getBoardCustomFields(boardId) → {Promise.<*>}

Description:

Get Board Custom Fields by id.

Source:

api/Boards.js, line 232

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) getBoardEnabledPowerUps(boardId) → {Promise.<*>}

Description:

get Board enabled PowerUps

Source:

api/Boards.js, line 693

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) getBoardField(boardId, field) → {Promise.<*>}

Description:

Get Board Field by id.

Source:

api/Boards.js, line 105

Parameters:

Name	Type	Description
`boardId`	string
`field`	string

Returns:

Type: Promise.<*>

(async) getBoardFilteredCards(boardId, filter) → {Promise.<*>}

Description:

Get Filtered Cards of a Board by id.

Source:

api/Boards.js, line 217

Parameters:

Name	Type	Description
`boardId`	string
`filter`	string

Returns:

Type: Promise.<*>

(async) getBoardFilteredLists(boardId, filter) → {Promise.<*>}

Description:

Get Filtered Lists of a Board by id.

Source:

api/Boards.js, line 355

Parameters:

Name	Type	Description
`boardId`	string
`filter`	string

Returns:

Type: Promise.<*>

(async) getBoardLabels(boardId, options) → {Promise.<*>}

Description:

Get Labels of a Board by id.

Source:

api/Boards.js, line 248

Parameters:

Name	Type	Description
`boardId`	string
`options`	Object	{fields, limit}

Returns:

Type: Promise.<*>

(async) getBoardLists(boardId, options) → {Promise.<*>}

Description:

Get Lists of a Board by id.

Source:

api/Boards.js, line 300

Parameters:

Name	Type	Description
`boardId`	string
`options`	Object	{filter, fields, limit, cards, card_fields}

Returns:

Type: Promise.<*>

(async) getBoardMembership(boardId) → {Promise.<*>}

Description:

Get Board Membership by id Board.

Source:

api/Boards.js, line 14

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) getBoardPowerUps(boardId, options) → {Promise.<*>}

Description:

get Board PowerUps

Source:

api/Boards.js, line 709

Parameters:

Name	Type	Description
`boardId`	string
`options`	Object	{filter}

Returns:

Type: Promise.<*>

(async) getBoardboardStars(boardId, options) → {Promise.<*>}

Description:

Get Board stars of a board by id.

Source:

api/Boards.js, line 162

Parameters:

Name	Type	Description
`boardId`	string
`options`	string	{filter}

Returns:

Type: Promise.<*>

(async) getBulkOrganizationCanAddToEnterprise(idEntreprise, idOrganizations) → {Promise.<*>}

Description:

Get Bulk Organization can be added to an enterprise.

Source:

api/Enterprises.js, line 199

Parameters:

Name	Type	Description
`idEntreprise`	string
`idOrganizations`	string

Returns:

Type: Promise.<*>

(async) getCard(idCard, options) → {Promise.<*>}

Description:

Get card by id.

Source:

api/Cards.js, line 56

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{fields, actions, attachments, attachment_fields, members, member_fields, membersVoted, memberVoted_fields, checkItemStates, checklists, checklist_fields, list, pluginData, stickers, sticker_fields, customFieldItems}

Returns:

Type: Promise.<*>

(async) getCardActions(idCard, options) → {Promise.<*>}

Description:

Get card actions by id.

Source:

api/Cards.js, line 162

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{filter, page}

Returns:

Type: Promise.<*>

(async) getCardAttachment(idCard, idAttachment, options) → {Promise.<*>}

Description:

Get card attachment by id.

Source:

api/Cards.js, line 244

Parameters:

Name	Type	Description
`idCard`	string
`idAttachment`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getCardAttachments(idCard, options) → {Promise.<*>}

Description:

Get card attachments by id.

Source:

api/Cards.js, line 188

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{fields, filter}

Returns:

Type: Promise.<*>

(async) getCardBoard(idCard, options) → {Promise.<*>}

Description:

Get the board that a card is on.

Source:

api/Cards.js, line 285

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getCardCheckItem(idCard, idCheckItem, options) → {Promise.<*>}

Description:

Get card checklist by id.

Source:

api/Cards.js, line 391

Parameters:

Name	Type	Description
`idCard`	string
`idCheckItem`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getCardCheckItems(idCard, options) → {Promise.<*>}

Description:

Get card check items by id.

Source:

api/Cards.js, line 310

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getCardChecklists(idCard, options) → {Promise.<*>}

Description:

Get card checklists by id.

Source:

api/Cards.js, line 335

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{checkItems, checkItem_fields, filter, fields}

Returns:

Type: Promise.<*>

(async) getCardCustomFieldItems(idCard) → {Promise.<*>}

Description:

Get card custom field item by id.

Source:

api/Cards.js, line 739

Parameters:

Name	Type	Description
`idCard`	string

Returns:

Type: Promise.<*>

(async) getCardField(idCard, field) → {Promise.<*>}

Description:

Get card field by id.

Source:

api/Cards.js, line 146

Parameters:

Name	Type	Description
`idCard`	string
`field`	string

Returns:

Type: Promise.<*>

(async) getCardList(idCard, options) → {Promise.<*>}

Description:

Get card list by id.

Source:

api/Cards.js, line 460

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getCardMembers(idCard, options) → {Promise.<*>}

Description:

Get card members by id.

Source:

api/Cards.js, line 485

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getCardPluginData(idCard) → {Promise.<*>}

Description:

Get card plugin data by id.

Source:

api/Cards.js, line 549

Parameters:

Name	Type	Description
`idCard`	string

Returns:

Type: Promise.<*>

(async) getCardSticker(idCard, idSticker, options) → {Promise.<*>}

Description:

Get card sticker by id.

Source:

api/Cards.js, line 620

Parameters:

Name	Type	Description
`idCard`	string
`idSticker`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getCardStickers(idCard, options) → {Promise.<*>}

Description:

Get card sticker by id.

Source:

api/Cards.js, line 565

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getChecklist(idChecklist, options) → {Promise.<*>}

Description:

Get checklist by id.

Source:

api/Checklists.js, line 41

Parameters:

Name	Type	Description
`idChecklist`	string
`options`	Object	{cards, checkItems, checkItems_fields, fields}

Returns:

Type: Promise.<*>

(async) getChecklistBoard(idChecklist, options) → {Promise.<*>}

Description:

Get Checklist board by id.

Source:

api/Checklists.js, line 143

Parameters:

Name	Type	Description
`idChecklist`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getChecklistCard(idChecklist) → {Promise.<*>}

Description:

Get Checklist card by id.

Source:

api/Checklists.js, line 167

Parameters:

Name	Type	Description
`idChecklist`	string

Returns:

Type: Promise.<*>

(async) getChecklistCheckItem(idChecklist, options) → {Promise.<*>}

Description:

Get Checklist checkItem by id.

Source:

api/Checklists.js, line 183

Parameters:

Name	Type	Description
`idChecklist`	string
`options`	Object	{filter, fields}

Returns:

Type: Promise.<*>

(async) getChecklistCheckItemField(idChecklist, idCheckItem) → {Promise.<*>}

Description:

Get checklist checkItem field by id.

Source:

api/Checklists.js, line 238

Parameters:

Name	Type	Description
`idChecklist`	string
`idCheckItem`	string

Returns:

Type: Promise.<*>

(async) getChecklistField(idChecklist, field) → {Promise.<*>}

Description:

Get checklist field by id.

Source:

api/Checklists.js, line 110

Parameters:

Name	Type	Description
`idChecklist`	string
`field`	string

Returns:

Type: Promise.<*>

(async) getCustomBoardBackgroundMember(idMember, idBoardBackground) → {Promise.<*>}

Description:

Get Custom Board Background Member by id.

Source:

api/Members.js, line 441

Parameters:

Name	Type	Description
`idMember`	string
`idBoardBackground`	string

Returns:

Type: Promise.<*>

(async) getCustomEmojiMember(idMember, idEmoji, options) → {Promise.<*>}

Description:

Get Custom Emoji Member by id.

Source:

api/Members.js, line 533

Parameters:

Name	Type	Description
`idMember`	string
`idEmoji`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getCustomEmojiMembers(idMember, idEmoji, options) → {Promise.<*>}

Description:

Get Custom Emoji Members by id.

Source:

api/Members.js, line 559

Parameters:

Name	Type	Description
`idMember`	string
`idEmoji`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getCustomField(idCustomField) → {Promise.<*>}

Description:

Get custom field by id.

Source:

api/CustomFields.js, line 43

Parameters:

Name	Type	Description
`idCustomField`	string

Returns:

Type: Promise.<*>

(async) getCustomFieldOption(idCustomField, idOption) → {Promise.<*>}

Description:

Get custom field option by id.

Source:

api/CustomFields.js, line 131

Parameters:

Name	Type	Description
`idCustomField`	string
`idOption`	string

Returns:

Type: Promise.<*>

(async) getCustomFieldOptions(idCustomField) → {Promise.<*>}

Description:

Get custom field options.

Source:

api/CustomFields.js, line 100

Parameters:

Name	Type	Description
`idCustomField`	string

Returns:

Type: Promise.<*>

(async) getEmoji(options) → {Promise.<*>}

Description:

Get emojis

Source:

api/Emoji.js, line 14

Parameters:

Name	Type	Description
`options`

Returns:

Type: Promise.<*>

(async) getEnterprise(idEntreprise, options) → {Promise.<*>}

Description:

Get enterprise by id.

Source:

api/Enterprises.js, line 15

Parameters:

Name	Type	Description
`idEntreprise`	string
`options`	Object	{display, entities, fields, member, member_fields, member_filter, member_sort, member_sortBy, member_sortOrder, member_startIndex, member_count, organizations, organization_fields, organization_paid_account, organization_memberships

Returns:

Type: Promise.<*>

(async) getEnterpriseAdminMembers(idEntreprise, options-) → {Promise.<*>}

Description:

Get enterprise admin members by id.

Source:

api/Enterprises.js, line 69

Parameters:

Name	Type	Description
`idEntreprise`	string
`options-`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getEnterpriseAuditlogData(idEntreprise) → {Promise.<*>}

Description:

Get enterprise auditlog data by id.

Source:

api/Enterprises.js, line 53

Parameters:

Name	Type	Description
`idEntreprise`	string

Returns:

Type: Promise.<*>

(async) getEnterpriseClaimableOrganizations(idEntreprise, options) → {Promise.<*>}

Description:

Get Enterprise claimable organizations.

Source:

api/Enterprises.js, line 231

Parameters:

Name	Type	Description
`idEntreprise`	string
`options`	Object	{limit, cursor, name, activeSince, inactiveSince}

Returns:

Type: Promise.<*>

(async) getEnterpriseMember(idEntreprise, idMember, options) → {Promise.<*>}

Description:

Get enterprise member by id.

Source:

api/Enterprises.js, line 156

Parameters:

Name	Type	Description
`idEntreprise`	string
`idMember`	string
`options`	Object	{fields, organization_fields, board_fields}

Returns:

Type: Promise.<*>

(async) getEnterpriseMembers(idEntreprise, options) → {Promise.<*>}

Description:

Get enterprise members by id.

Source:

api/Enterprises.js, line 122

Parameters:

Name	Type	Description
`idEntreprise`	string
`options`	Object	{fields, filter, sort, sortBy, sortOrder, startIndex, count, organization_fields, board_fields}

Returns:

Type: Promise.<*>

(async) getEnterprisePendingOrganizations(idEntreprise, options) → {Promise.<*>}

Description:

Get Enterprise pending organizations.

Source:

api/Enterprises.js, line 260

Parameters:

Name	Type	Description
`idEntreprise`	string
`options`	Object	{activeSince, inactiveSince}

Returns:

Type: Promise.<*>

(async) getEnterpriseSignupUrl(idEntreprise, options) → {Promise.<*>}

Description:

Get entreprise Signup url.

Source:

api/Enterprises.js, line 94

Parameters:

Name	Type	Description
`idEntreprise`	string
`options`	Object	{returnUrl, authenticate, confirmationAccepted, tosAccepted}

Returns:

Type: Promise.<*>

(async) getLabel(idLabel, options) → {Promise.<*>}

Description:

Get label by id.

Source:

api/Labels.js, line 15

Parameters:

Name	Type	Description
`idLabel`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getList(idList, options) → {Promise.<*>}

Description:

Get list by id.

Source:

api/Lists.js, line 15

Parameters:

Name	Type	Description
`idList`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getListActions(idList, options) → {Promise.<*>}

Description:

Get list actions by id.

Source:

api/Lists.js, line 194

Parameters:

Name	Type	Description
`idList`	string
`options`	Object	{filter}

Returns:

Type: Promise.<*>

(async) getListBoard(idList, options) → {Promise.<*>}

Description:

Get list board by id.

Source:

api/Lists.js, line 219

Parameters:

Name	Type	Description
`idList`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getListCards(idList) → {Promise.<*>}

Description:

Get list cards by id.

Source:

api/Lists.js, line 243

Parameters:

Name	Type	Description
`idList`	string

Returns:

Type: Promise.<*>

(async) getMember(idMember, options) → {Promise.<*>}

Description:

Get member by id.

Source:

api/Members.js, line 14

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{actions, boards, boardBackgrounds, boardsInvited, boardsInvited_fields, boardStars, cards, customBoardBackgrounds, customEmoji, customStickers, fields, notifications, organizations, organization_fields, organization_paid_account, organizationInvited, organizationInvited_fields, paid_account, savedSearches, tokens}

Returns:

Type: Promise.<*>

(async) getMemberActions(idMember, options) → {Promise.<*>}

Description:

Update member action by id.

Source:

api/Members.js, line 106

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{filter}

Returns:

Type: Promise.<*>

(async) getMemberBoardBackground(idMember, idBoardBackground, options) → {Promise.<*>}

Description:

Get member board background by id.

Source:

api/Members.js, line 173

Parameters:

Name	Type	Description
`idMember`	string
`idBoardBackground`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getMemberBoardStar(idMember, idStar) → {Promise.<*>}

Description:

Get member board star by id.

Source:

api/Members.js, line 273

Parameters:

Name	Type	Description
`idMember`	string
`idStar`	string

Returns:

Type: Promise.<*>

(async) getMemberBoardStars(idMember) → {Promise.<*>}

Description:

Get member board stars by id.

Source:

api/Members.js, line 240

Parameters:

Name	Type	Description
`idMember`	string

Returns:

Type: Promise.<*>

(async) getMemberBoards(idMember, options) → {Promise.<*>}

Description:

Get member boards by id.

Source:

api/Members.js, line 331

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{filter, fields, lists, organization, organization_fields}

Returns:

Type: Promise.<*>

(async) getMemberBoardsInvited(idMember, options) → {Promise.<*>}

Description:

Get member boards invited by id.

Source:

api/Members.js, line 360

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getMemberCard(idMember, options) → {Promise.<*>}

Description:

Get cards of a member by id.

Source:

api/Members.js, line 385

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{filter}

Returns:

Type: Promise.<*>

(async) getMemberCustomBoardBackgrounds(idMember, options) → {Promise.<*>}

Description:

Get member custom board backgrounds by id.

Source:

api/Members.js, line 131

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{filter}

Returns:

Type: Promise.<*>

(async) getMemberCustomBoardBackgrounds(idMember) → {Promise.<*>}

Description:

Get custom board backgrounds of a member by id.

Source:

api/Members.js, line 409

Parameters:

Name	Type	Description
`idMember`	string

Returns:

Type: Promise.<*>

(async) getMemberCustomEmoji(idMember) → {Promise.<*>}

Description:

Get Custom Emoji of a member by id.

Source:

api/Members.js, line 499

Parameters:

Name	Type	Description
`idMember`	string

Returns:

Type: Promise.<*>

(async) getMemberCustomSticker(idMember, idSticker, options) → {Promise.<*>}

Description:

Get Custom Sticker of a member by id.

Source:

api/Members.js, line 616

Parameters:

Name	Type	Description
`idMember`	string
`idSticker`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getMemberCustomStickers(idMember) → {Promise.<*>}

Description:

Get Custom Stickers of a member by id.

Source:

api/Members.js, line 583

Parameters:

Name	Type	Description
`idMember`	string

Returns:

Type: Promise.<*>

(async) getMemberField(idMember, field) → {Promise.<*>}

Description:

Get member field by id.

Source:

api/Members.js, line 90

Parameters:

Name	Type	Description
`idMember`	string
`field`	string

Returns:

Type: Promise.<*>

(async) getMemberNotifications(idMember, options) → {Promise.<*>}

Description:

Get member notifications.

Source:

api/Members.js, line 657

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{entities, display, filter, read_filter, fields, limit, page, before, since, memberCreator, memberCreator_fields}

Returns:

Type: Promise.<*>

(async) getMemberOrganizations(idMember, options) → {Promise.<*>}

Description:

Get member organizations.

Source:

api/Members.js, line 692

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{filter, fields, paid_account}

Returns:

Type: Promise.<*>

(async) getMemberOrganizationsInvited(idMember, options) → {Promise.<*>}

Description:

Get member organizations invited.

Source:

api/Members.js, line 719

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getMemberSavedSearch(idMember, idSearch) → {Promise.<*>}

Description:

Get Member saved search by id.

Source:

api/Members.js, line 777

Parameters:

Name	Type	Description
`idMember`	string
`idSearch`	string

Returns:

Type: Promise.<*>

(async) getMemberSavedSearched(idMember) → {Promise.<*>}

Description:

get Member saved searches.

Source:

api/Members.js, line 743

Parameters:

Name	Type	Description
`idMember`	string

Returns:

Type: Promise.<*>

(async) getMemberTokens(idMember, options) → {Promise.<*>}

Description:

Get Member tokens.

Source:

api/Members.js, line 837

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{webhooks}

Returns:

Type: Promise.<*>

(async) getMembersVotedOnACard(idCard, options) → {Promise.<*>}

Description:

Get members voted on a card by id.

Source:

api/Cards.js, line 510

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getNotification(idNotification, options) → {Promise.<*>}

Description:

Get notification by id.

Source:

api/Notifications.js, line 14

Parameters:

Name	Type	Description
`idNotification`	string
`options`	Object	{board, board_fields, card, card_fields, display, entities, fields, list, member, member_fields, memberCreator, memberCreator_fields, organization, organization_fields}

Returns:

Type: Promise.<*>

(async) getNotificationBoard(idNotification, options) → {Promise.<*>}

Description:

Get notification board by id.

Source:

api/Notifications.js, line 143

Parameters:

Name	Type	Description
`idNotification`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getNotificationCard(idNotification, options) → {Promise.<*>}

Description:

Get notification card by id.

Source:

api/Notifications.js, line 168

Parameters:

Name	Type	Description
`idNotification`	string
`options`	string	{fields}

Returns:

Type: Promise.<*>

(async) getNotificationField(idNotification, field) → {Promise.<*>}

Description:

Get notification field by id.

Source:

api/Notifications.js, line 77

Parameters:

Name	Type	Description
`idNotification`	string
`field`	string

Returns:

Type: Promise.<*>

(async) getNotificationList(idNotification, options) → {Promise.<*>}

Description:

Get notification list by id.

Source:

api/Notifications.js, line 193

Parameters:

Name	Type	Description
`idNotification`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getNotificationMember(idNotification, options) → {Promise.<*>}

Description:

Get notification member by id.

Source:

api/Notifications.js, line 218

Parameters:

Name	Type	Description
`idNotification`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getNotificationMemberCreator(idNotification, options) → {Promise.<*>}

Description:

Get notification member creator by id.

Source:

api/Notifications.js, line 243

Parameters:

Name	Type	Description
`idNotification`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getNotificationOrganization(idNotification, options) → {Promise.<*>}

Description:

Get notification organization by id.

Source:

api/Notifications.js, line 268

Parameters:

Name	Type	Description
`idNotification`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getOrganization(idOrganization) → {Promise.<*>}

Description:

Get an organization by id.

Source:

api/Organizations.js, line 41

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) getOrganizationActions(idOrganization) → {Promise.<*>}

Description:

Get organizations actions by id.

Source:

api/Organizations.js, line 123

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) getOrganizationBoards(idOrganization, options) → {Promise.<*>}

Description:

Get organization boards by id.

Source:

api/Organizations.js, line 139

Parameters:

Name	Type	Description
`idOrganization`	string
`options`	Object	{filter, fields}

Returns:

Type: Promise.<*>

(async) getOrganizationCanAddToEnterprise(idEntreprise, idOrganization) → {Promise.<*>}

Description:

Get Organization can be added to an enterprise.

Source:

api/Enterprises.js, line 183

Parameters:

Name	Type	Description
`idEntreprise`	string
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) getOrganizationField(idOrganization, field) → {Promise.<*>}

Description:

Get an organization field by id.

Source:

api/Organizations.js, line 108

Parameters:

Name	Type	Description
`idOrganization`	string
`field`	string

Returns:

Type: Promise.<*>

(async) getOrganizationMembers(idOrganization) → {Promise.<*>}

Description:

Get organization members by id.

Source:

api/Organizations.js, line 204

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) getOrganizationMembershipById(idOrganization, idMembership, options) → {Promise.<*>}

Description:

Get organization Membership by id.

Source:

api/Organizations.js, line 274

Parameters:

Name	Type	Description
`idOrganization`	string
`idMembership`	string
`options`	Object	{member}

Returns:

Type: Promise.<*>

(async) getOrganizationMemberships(idOrganization, options) → {Promise.<*>}

Description:

Get organization Memberships by id.

Source:

api/Organizations.js, line 247

Parameters:

Name	Type	Description
`idOrganization`	string
`options`	Object	{filter, members}

Returns:

Type: Promise.<*>

(async) getOrganizationNewBillableGuests(idOrganization, idBoard) → {Promise.<*>}

Description:

Get organization new billable guests by id.

Source:

api/Organizations.js, line 496

Parameters:

Name	Type	Description
`idOrganization`	string
`idBoard`	string

Returns:

Type: Promise.<*>

(async) getOrganizationPluginData(idOrganization) → {Promise.<*>}

Description:

Get organization plugin data by id.

Source:

api/Organizations.js, line 298

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) getOrganizationTags(idOrganization) → {Promise.<*>}

Description:

Get organization Tags by id.

Source:

api/Organizations.js, line 313

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) getPlugin(idPlugin) → {Promise.<*>}

Description:

Get plugin by id

Source:

api/Plugins.js, line 14

Parameters:

Name	Type	Description
`idPlugin`	string

Returns:

Type: Promise.<*>

(async) getPluginMemberPrivacy(idPlugin) → {Promise.<*>}

Description:

Get plugin Member Privacy by id

Source:

api/Plugins.js, line 72

Parameters:

Name	Type	Description
`idPlugin`	string

Returns:

Type: Promise.<*>

(async) getToken(idToken, options) → {Promise.<*>}

Description:

Get token by id.

Source:

api/Tokens.js, line 14

Parameters:

Name	Type	Description
`idToken`	string
`options`	Object	{fields, webhooks}

Returns:

Type: Promise.<*>

(async) getTokenMember(idToken, options) → {Promise.<*>}

Description:

Get token member by id.

Source:

api/Tokens.js, line 40

Parameters:

Name	Type	Description
`idToken`	string
`options`	Object	{fields}

Returns:

Type: Promise.<*>

(async) getTokenWebhooks(idToken) → {Promise.<*>}

Description:

Get token webhooks by id Token.

Source:

api/Tokens.js, line 64

Parameters:

Name	Type	Description
`idToken`	string

Returns:

Type: Promise.<*>

(async) getWebhook(idWebhook) → {Promise.<*>}

Description:

Get webhooks by id.

Source:

api/Webhooks.js, line 37

Parameters:

Name	Type	Description
`idWebhook`	string

Returns:

Type: Promise.<*>

(async) getWebhookBelongingToToken(idToken, idWebhook) → {Promise.<*>}

Description:

Get webhook belonging to token by Id Token and Id Webhook.

Source:

api/Tokens.js, line 107

Parameters:

Name	Type	Description
`idToken`	string
`idWebhook`	string

Returns:

Type: Promise.<*>

(async) getWebhookField(idWebhook, field) → {Promise.<*>}

Description:

Get webhook field by id and field.

Source:

api/Webhooks.js, line 96

Parameters:

Name	Type	Description
`idWebhook`	string
`field`	string

Returns:

Type: Promise.<*>

(async) inviteMemberEmailToBoard(boardId, email, options) → {Promise.<*>}

Description:

Invite a Member to a Board by his email.

Source:

api/Boards.js, line 387

Parameters:

Name	Type	Description
`boardId`	string
`email`	string
`options`	Object	{type, fullName}

Returns:

Type: Promise.<*>

(async) markAllNotificationsAsRead(options) → {Promise.<*>}

Description:

Mark all notifications as read.

Source:

api/Notifications.js, line 92

Parameters:

Name	Type	Description
`options`	string	{read, ids}

Returns:

Type: Promise.<*>

(async) markBoardAsViewed(boardId) → {Promise.<*>}

Description:

Mark a board as viewed

Source:

api/Boards.js, line 678

Parameters:

Name	Type	Description
`boardId`	string

Returns:

Type: Promise.<*>

(async) markCardNotificationAsRead(idCard) → {Promise.<*>}

Description:

Mark card notification as read by id.

Source:

api/Cards.js, line 845

Parameters:

Name	Type	Description
`idCard`	string

Returns:

Type: Promise.<*>

(async) moveListCards(idList, idList2, idBoard) → {Promise.<*>}

Description:

Move all cards of a list to another list.

Source:

api/Lists.js, line 111

Parameters:

Name	Type	Description
`idList`	string
`idList2`	string
`idBoard`	string

Returns:

Type: Promise.<*>

(async) moveListToBoard(idList, idBoard) → {Promise.<*>}

Description:

Move list to another board.

Source:

api/Lists.js, line 152

Parameters:

Name	Type	Description
`idList`	string
`idBoard`	string

Returns:

Type: Promise.<*>

(async) removeBoardMember(boardId, memberId) → {Promise.<*>}

Description:

Remove a member from a board by his id.

Source:

api/Boards.js, line 440

Parameters:

Name	Type	Description
`boardId`	string
`memberId`	string

Returns:

Type: Promise.<*>

(async) removeCardLabel(idCard, idLabel) → {Promise.<*>}

Description:

Remove label from card by id.

Source:

api/Cards.js, line 861

Parameters:

Name	Type	Description
`idCard`	string
`idLabel`	string

Returns:

Type: Promise.<*>

(async) removeCardMember(idCard, idMember) → {Promise.<*>}

Description:

Remove member from card by id.

Source:

api/Cards.js, line 877

Parameters:

Name	Type	Description
`idCard`	string
`idMember`	string

Returns:

Type: Promise.<*>

(async) removeCardMemberVote(idCard, idMember) → {Promise.<*>}

Description:

Remove member vote from card by id.

Source:

api/Cards.js, line 893

Parameters:

Name	Type	Description
`idCard`	string
`idMember`	string

Returns:

Type: Promise.<*>

(async) removeEnterpriseAdminMember(idEntreprise, idMember) → {Promise.<*>}

Description:

Remove Enterprise Member Admin.

Source:

api/Enterprises.js, line 389

Parameters:

Name	Type	Description
`idEntreprise`	string
`idMember`	string

Returns:

Type: Promise.<*>

(async) removeGoogleAppsDomain(idOrganization) → {Promise.<*>}

Description:

Remove google apps domain by id.

Source:

api/Organizations.js, line 449

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) removeOrganizationMember(idOrganization, idMember) → {Promise.<*>}

Description:

Remove organization member by id.

Source:

api/Organizations.js, line 361

Parameters:

Name	Type	Description
`idOrganization`	string
`idMember`	string

Returns:

Type: Promise.<*>

(async) removeOrganizationMemberAndAllOrganizationBoards(idOrganization, idMember) → {Promise.<*>}

Description:

Remove organization member and all organization boards by id.

Source:

api/Organizations.js, line 434

Parameters:

Name	Type	Description
`idOrganization`	string
`idMember`	string

Returns:

Type: Promise.<*>

(async) retrieveOrganizationExports(idOrganization) → {Promise.<*>}

Description:

Retrieve organization exports by id.

Source:

api/Organizations.js, line 164

Parameters:

Name	Type	Description
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) searchMembers(query, options) → {Promise.<*>}

Description:

Search Members

Source:

api/Search.js, line 66

Parameters:

Name	Type	Description
`query`	string
`options`	Object	{limit, idBoard, idOrganizations, onlyOrgMembers}

Returns:

Type: Promise.<*>

(async) searchTrello(query, options) → {Promise.<*>}

Description:

Search Trello

Source:

api/Search.js, line 15

Parameters:

Name	Type	Description
`query`	string
`options`	Object

Returns:

Type: Promise.<*>

(async) transferOrganizationToEnterprise(idEntreprise, idOrganization) → {Promise.<*>}

Description:

Transfer Organization to Enterprise.

Source:

api/Enterprises.js, line 311

Parameters:

Name	Type	Description
`idEntreprise`	string
`idOrganization`	string

Returns:

Type: Promise.<*>

(async) updateAction(idAction, text) → {Promise.<*>}

Description:

Update an action by ID.

Source:

api/Actions.js, line 46

Parameters:

Name	Type	Description
`idAction`	string
`text`	string

Returns:

Type: Promise.<*>

(async) updateActionComment(idAction, value) → {Promise.<*>}

Description:

Update the action's comment.

Source:

api/Actions.js, line 244

Parameters:

Name	Type	Description
`idAction`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateBoard(boardId, options) → {Promise.<*>}

Description:

Update Board by id.

Source:

api/Boards.js, line 45

Parameters:

Name	Type	Description
`boardId`	string
`options`	Object	{name, desc, descData, closed, subscribed, idOrganization, prefs_permissionLevel, prefs_voting, prefs_comments, prefs_invitations, prefs_selfJoin, prefs_cardCovers, prefs_background, prefs_cardAging, prefs_calendarFeedEnabled, labelNames_green, labelNames_yellow, labelNames_orange, labelNames_red, labelNames_purple, labelNames_blue

Returns:

Type: Promise.<*>

(async) updateBoardEmailPositionPref(boardId, value) → {Promise.<*>}

Description:

Update the board email position preference.

Source:

api/Boards.js, line 483

Parameters:

Name	Type	Description
`boardId`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateBoardIdEmailListPref(boardId, value) → {Promise.<*>}

Description:

Update the board id email list preference.

Source:

api/Boards.js, line 499

Parameters:

Name	Type	Description
`boardId`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateBoardMembership(boardId, membershipId, type, options) → {Promise.<*>}

Description:

Update the Membership of a Member on a Board.

Source:

api/Boards.js, line 458

Parameters:

Name	Type	Description
`boardId`	string
`membershipId`	string
`type`	string
`options`	Object	{member_fields}

Returns:

Type: Promise.<*>

(async) updateBoardShowListGuidePref(boardId, value) → {Promise.<*>}

Description:

Update the board show list guide preference.

Source:

api/Boards.js, line 515

Parameters:

Name	Type	Description
`boardId`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateBoardShowSidebarActivityPref(boardId, value) → {Promise.<*>}

Description:

Update the board show sidebar activity preference.

Source:

api/Boards.js, line 547

Parameters:

Name	Type	Description
`boardId`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateBoardShowSidebarBoardActionsPref(boardId, value) → {Promise.<*>}

Description:

Update the board show sidebar board actions preference.

Source:

api/Boards.js, line 563

Parameters:

Name	Type	Description
`boardId`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateBoardShowSidebarMembersPref(boardId, value) → {Promise.<*>}

Description:

Update the board show sidebar board members preference.

Source:

api/Boards.js, line 579

Parameters:

Name	Type	Description
`boardId`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateBoardShowSidebarPref(boardId, value) → {Promise.<*>}

Description:

Update the board show sidebar preference.

Source:

api/Boards.js, line 531

Parameters:

Name	Type	Description
`boardId`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateCard(idCard, options) → {Promise.<*>}

Description:

Update card by id.

Source:

api/Cards.js, line 96

Parameters:

Name	Type	Description
`idCard`	string
`options`	Object	{name, desc, pos, due, start, dueComplete, subscribed, address, locationName, coordinates, cover}

Returns:

Type: Promise.<*>

(async) updateCardCheckItem(idCard, idCheckItem, options) → {Promise.<*>}

Description:

Update card checkitem by id.

Source:

api/Cards.js, line 417

Parameters:

Name	Type	Description
`idCard`	string
`idCheckItem`	string
`options`	Object	{name, pos, state}

Returns:

Type: Promise.<*>

(async) updateCardCheckItemOnChecklist(idCard, idChecklist, idCheckItem, options) → {Promise.<*>}

Description:

Update card check item on checklist by id.

Source:

api/Cards.js, line 911

Parameters:

Name	Type	Description
`idCard`	string
`idChecklist`	string
`idCheckItem`	string
`options`	Object	{pos}

Returns:

Type: Promise.<*>

(async) updateCardCommentAction(idCard, idAction, text) → {Promise.<*>}

Description:

Update Card comment action by id.

Source:

api/Cards.js, line 692

Parameters:

Name	Type	Description
`idCard`	string
`idAction`	string
`text`	string

Returns:

Type: Promise.<*>

(async) updateCardCustomFieldItem(idCard, idCustomField) → {Promise.<*>}

Description:

Update card custom field item by id.

Source:

api/Cards.js, line 724

Parameters:

Name	Type	Description
`idCard`	string
`idCustomField`	string

Returns:

Type: Promise.<*>

(async) updateCardSticker(idCard, idSticker, image, top, left, zIndex, options) → {Promise.<*>}

Description:

Update card sticker by id.

Source:

api/Cards.js, line 650

Parameters:

Name	Type	Description
`idCard`	string
`idSticker`	string
`image`
`top`
`left`
`zIndex`
`options`	Object	{rotate}

Returns:

Type: Promise.<*>

(async) updateChecklist(idChecklist, options) → {Promise.<*>}

Description:

Update checklist by id.

Source:

api/Checklists.js, line 69

Parameters:

Name	Type	Description
`idChecklist`	string
`options`	Object	{name, pos}

Returns:

Type: Promise.<*>

(async) updateChecklistField(idChecklist, field, value) → {Promise.<*>}

Description:

Update checklist field by id.

Source:

api/Checklists.js, line 127

Parameters:

Name	Type	Description
`idChecklist`	string
`field`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateCustomBoardBackgroundMember(idMember, idBoardBackground, options) → {Promise.<*>}

Description:

Update Custom Board Background Member by id.

Source:

api/Members.js, line 458

Parameters:

Name	Type	Description
`idMember`	string
`idBoardBackground`	string
`options`	Object	{tile, brightness}

Returns:

Type: Promise.<*>

(async) updateCustomField(idCustomField, options) → {Promise.<*>}

Description:

Update custom field.

Source:

api/CustomFields.js, line 59

Parameters:

Name	Type	Description
`idCustomField`	string
`options`	Object	{name, pos, display/cardFront}

Returns:

Type: Promise.<*>

(async) updateEnterpriseAdminMember(idEntreprise, idMember) → {Promise.<*>}

Description:

Update Enterprise Member Admin.

Source:

api/Enterprises.js, line 373

Parameters:

Name	Type	Description
`idEntreprise`	string
`idMember`	string

Returns:

Type: Promise.<*>

(async) updateEnterpriseMemberLicensed(idEntreprise, idMember, value) → {Promise.<*>}

Description:

Update Enterprise Member Licensed.

Source:

api/Enterprises.js, line 328

Parameters:

Name	Type	Description
`idEntreprise`	string
`idMember`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateLabel(idLabel, options) → {Promise.<*>}

Description:

Update label by id.

Source:

api/Labels.js, line 40

Parameters:

Name	Type	Description
`idLabel`	string
`options`	Object	{color, name}

Returns:

Type: Promise.<*>

(async) updateLabelField(idLabel, field, value) → {Promise.<*>}

Description:

Update label field by id.

Source:

api/Labels.js, line 82

Parameters:

Name	Type	Description
`idLabel`	string
`field`	string
`value`	string

Returns:

Type: Promise.<*>

(async) updateList(idList, options) → {Promise.<*>}

Description:

Update list by id.

Source:

api/Lists.js, line 40

Parameters:

Name	Type	Description
`idList`	string
`options`	Object	{name, closed, idBoard, pos, subscribed}

Returns:

Type: Promise.<*>

(async) updateListFields(idList, field, options) → {Promise.<*>}

Description:

Update fields of a list by id.

Source:

api/Lists.js, line 169

Parameters:

Name	Type	Description
`idList`	string
`field`	string
`options`	Object	{value}

Returns:

Type: Promise.<*>

(async) updateMember(idMember, options) → {Promise.<*>}

Description:

Update member by id.

Source:

api/Members.js, line 58

Parameters:

Name	Type	Description
`idMember`	string
`options`	Object	{fullName, bio, initials, username, avatarSource, prefs_colorBlind, prefs_locale, prefs_minutesBetweenSummaries}

Returns:

Type: Promise.<*>

(async) updateMemberBoardStarPosition(idMember, idStar, options) → {Promise.<*>}

Description:

Update member board star position by id.

Source:

api/Members.js, line 290

Parameters:

Name	Type	Description
`idMember`	string
`idStar`	string
`options`	Object	{pos}

Returns:

Type: Promise.<*>

(async) updateMemberSavedSearch(idMember, idSearch, options) → {Promise.<*>}

Description:

Update Member saved search.

Source:

api/Members.js, line 794

Parameters:

Name	Type	Description
`idMember`	string
`idSearch`	string
`options`	Object	{name, query, pos}

Returns:

Type: Promise.<*>

(async) updateNotificationReadStatus(idNotification, options) → {Promise.<*>}

Description:

Update notification Read status by id.

Source:

api/Notifications.js, line 52

Parameters:

Name	Type	Description
`idNotification`	string
`options`	Object	{unread}

Returns:

Type: Promise.<*>

(async) updateNotificationsReadStatus(id, options) → {Promise.<*>}

Description:

Update notifications read status.

Source:

api/Notifications.js, line 118

Parameters:

Name	Type	Description
`id`
`options`	value

Returns:

Type: Promise.<*>

(async) updateOrganization(idOrganization, options) → {Promise.<*>}

Description:

Update an organization by id.

Source:

api/Organizations.js, line 57

Parameters:

Name	Type	Description
`idOrganization`	string
`options`	Object

Returns:

Type: Promise.<*>

(async) updateOrganizationLogo(idOrganization, options) → {Promise.<*>}

Description:

Update organization logo by id.

Source:

api/Organizations.js, line 394

Parameters:

Name	Type	Description
`idOrganization`	string
`options`	Object	{file}

Returns:

Type: Promise.<*>

(async) updateOrganizationMember(idOrganization, idMember, type) → {Promise.<*>}

Description:

Update organization member by id.

Source:

api/Organizations.js, line 345

Parameters:

Name	Type	Description
`idOrganization`	string
`idMember`	string
`type`	string

Returns:

Type: Promise.<*>

(async) updateOrganizationMembers(idOrganization, email, fullName, options) → {Promise.<*>}

Description:

Update organization members by id.

Source:

api/Organizations.js, line 222

Parameters:

Name	Type	Description
`idOrganization`	string
`email`	string
`fullName`	string
`options`	Object	{type}

Returns:

Type: Promise.<*>

(async) updatePlugin(idPlugin) → {Promise.<*>}

Description:

Update plugin by id

Source:

api/Plugins.js, line 29

Parameters:

Name	Type	Description
`idPlugin`	string

Returns:

Type: Promise.<*>

(async) updatePluginListing(idPlugin, idListing, options) → {Promise.<*>}

Description:

Update plugin Member Privacy by id

Source:

api/Plugins.js, line 89

Parameters:

Name	Type	Description
`idPlugin`	string
`idListing`	string
`options`	Object	{description, locale, overview, name}

Returns:

Type: Promise.<*>

(async) updateWebhook(idWebhook, options) → {Promise.<*>}

Description:

Update webhook by id.

Source:

api/Webhooks.js, line 53

Parameters:

Name	Type	Description
`idWebhook`	string
`options`	Object	{description, callbackURL, idModel, active}

Returns:

Type: Promise.<*>

(async) updateWebhookCreatedByToken(idToken, idWebhook, options) → {Promise.<*>}

Description:

Update webhook created by token by Id Token and Id Webhook.

Source:

api/Tokens.js, line 124

Parameters:

Name	Type	Description
`idToken`	string
`idWebhook`	string
`options`	Object	{description, callbackURL, idModel}

Returns:

Type: Promise.<*>

(async) uploadMemberCustomBoardBackground(idMember, idBoardBackground, options) → {Promise.<*>}

Description:

Upload member custom board background by id.

Source:

api/Members.js, line 199

Parameters:

Name	Type	Description
`idMember`	string
`idBoardBackground`	string
`options`	Object	{brightness, tile}

Returns:

Type: Promise.<*>

(async) uploadMemberNewBoardBackground(idMember, file) → {Promise.<*>}

Description:

Upload member new board background by id.

Source:

api/Members.js, line 156

Parameters:

Name	Type	Description
`idMember`	string
`file`

Returns:

Type: Promise.<*>