Trello PHP API Client Documentation

Introduction¶

The Tectalic Trello REST API Client is a package that provides a convenient and straightforward way to interact with the Trello API from your PHP application.

You can purchase this package from https://tectalic.com/apis/trello.

Installation¶

System Requirements¶

• PHP version 7.2.5 or newer (including PHP 8.0 and 8.1)
• PHP JSON extension installed if using PHP 7.x. As of PHP 8.0, this extension became a core PHP extension so is always enabled.
• A PSR-18 compatible HTTP client such as ‘Guzzle’ or the ‘Symfony HTTP Client’.

Composer Installation¶

To install this package into your PHP project, we recommend using Composer.

Please see the detailed instructions on configuring your project to access the Tectalic Composer repository.

You will need to log into the Tectalic account that purchased the Tectalic Trello REST API Client package to access these instructions.

Once you have followed the above instructions, install the package into your project:

composer require tectalic/trello

Manual Installation¶

If you aren’t using Composer in your PHP project, you can choose to Download the latest release and install it into your PHP project manually.

If doing this, you will need to ensure that all dependencies listed in the package’s composer.json file are also installed.

Usage¶

After installing the Tectalic Trello REST API Client package into your project, ensure you also have a compatible PSR-18 HTTP client such as ‘Guzzle’ or the Symfony ‘HTTP Client’.

You can use the following code sample and customize it to suit your application.

// Load your project's composer autoloader (if you aren't already doing so).
require_once(__DIR__ . '/vendor/autoload.php');

use Symfony\Component\HttpClient\Psr18Client;
use Tectalic\Trello\Authentication;
use Tectalic\Trello\Client;
use Tectalic\Trello\Manager;
 
// Build a Tectalic Trello REST API Client globally.
$auth = new Authentication('key');
$httpClient = new Psr18Client();
Manager::build($httpClient, $auth);
 
// or
 
// Build a Tectalic Trello REST API Client manually.
$auth = new Authentication('key');
$httpClient = new Psr18Client();
$client = new Client($httpClient, $auth, Manager::BASE_URI);

Authentication¶

To authenticate your API requests, you will need to provide an Authentication ($auth) object when calling Manager::build().

Authentication to the Trello API is by API Key Query authentication.

Please see the Trello API documentation for more details on obtaining your authentication credentials.

In the Usage code above, customize the Authentication constructor to your needs. For example, you may wish to define your credentials in an environment variable and pass it to the constructor.

Client Class¶

The primary class you will interact with is the Client class (Tectalic\Trello\Client).

This Client class also contains the helper methods that let you quickly access the 186 API Handlers.

Please see below for a complete list of supported handlers and methods.

Supported API Handlers and Methods¶

This package supports 324 API Methods, which are grouped into 186 API Handlers.

See the table below for a full list of API Handlers and Methods.

API Handler Class and Method Name	Description	API Verb and URL
Actions::getActionsById()	getActionsByIdAction()	GET /actions/{idAction}
Actions::updateActionsById()	updateActionsByIdAction()	PUT /actions/{idAction}
Actions::deleteActionsById()	deleteActionsByIdAction()	DELETE /actions/{idAction}
Actions::getActionsByIdActionByField()	getActionsByIdActionByField()	GET /actions/{idAction}/{field}
ActionsBoard::getActionsBoardById()	getActionsBoardByIdAction()	GET /actions/{idAction}/board
ActionsBoard::getActionsBoardByIdActionByField()	getActionsBoardByIdActionByField()	GET /actions/{idAction}/board/{field}
ActionsCard::getActionsCardById()	getActionsCardByIdAction()	GET /actions/{idAction}/card
ActionsCard::getActionsCardByIdActionByField()	getActionsCardByIdActionByField()	GET /actions/{idAction}/card/{field}
ActionsDisplay::getActionsDisplayById()	getActionsDisplayByIdAction()	GET /actions/{idAction}/display
ActionsEntities::getActionsEntitiesById()	getActionsEntitiesByIdAction()	GET /actions/{idAction}/entities
ActionsList::getActionsListById()	getActionsListByIdAction()	GET /actions/{idAction}/list
ActionsList::getActionsListByIdActionByField()	getActionsListByIdActionByField()	GET /actions/{idAction}/list/{field}
ActionsMember::getActionsMemberById()	getActionsMemberByIdAction()	GET /actions/{idAction}/member
ActionsMember::getActionsMemberByIdActionByField()	getActionsMemberByIdActionByField()	GET /actions/{idAction}/member/{field}
ActionsMemberCreator::getActionsMemberCreatorById()	getActionsMemberCreatorByIdAction()	GET /actions/{idAction}/memberCreator
ActionsMemberCreator::getActionsMemberCreatorByIdActionByField()	getActionsMemberCreatorByIdActionByField()	GET /actions/{idAction}/memberCreator/{field}
ActionsOrganization::getActionsOrganizationById()	getActionsOrganizationByIdAction()	GET /actions/{idAction}/organization
ActionsOrganization::getActionsOrganizationByIdActionByField()	getActionsOrganizationByIdActionByField()	GET /actions/{idAction}/organization/{field}
ActionsText::updateActionsTextById()	updateActionsTextByIdAction()	PUT /actions/{idAction}/text
Batch::get()	getBatch()	GET /batch
Boards::add()	addBoards()	POST /boards
Boards::getBoardsById()	getBoardsByIdBoard()	GET /boards/{idBoard}
Boards::updateBoardsById()	updateBoardsByIdBoard()	PUT /boards/{idBoard}
Boards::getBoardsByIdBoardByField()	getBoardsByIdBoardByField()	GET /boards/{idBoard}/{field}
BoardsActions::getBoardsActionsById()	getBoardsActionsByIdBoard()	GET /boards/{idBoard}/actions
BoardsBoardStars::getBoardsBoardStarsById()	getBoardsBoardStarsByIdBoard()	GET /boards/{idBoard}/boardStars
BoardsCalendarKeyGenerate::addBoardsCalendarKeyGenerateById()	addBoardsCalendarKeyGenerateByIdBoard()	POST /boards/{idBoard}/calendarKey/generate
BoardsCards::getBoardsCardsById()	getBoardsCardsByIdBoard()	GET /boards/{idBoard}/cards
BoardsCards::getBoardsCardsByIdBoardByFilter()	getBoardsCardsByIdBoardByFilter()	GET /boards/{idBoard}/cards/{filter}
BoardsCards::getBoardsCardsByIdBoardById()	getBoardsCardsByIdBoardByIdCard()	GET /boards/{idBoard}/cards/{idCard}
BoardsChecklists::getBoardsChecklistsById()	getBoardsChecklistsByIdBoard()	GET /boards/{idBoard}/checklists
BoardsChecklists::addBoardsChecklistsById()	addBoardsChecklistsByIdBoard()	POST /boards/{idBoard}/checklists
BoardsClosed::updateBoardsClosedById()	updateBoardsClosedByIdBoard()	PUT /boards/{idBoard}/closed
BoardsDeltas::getBoardsDeltasById()	getBoardsDeltasByIdBoard()	GET /boards/{idBoard}/deltas
BoardsDesc::updateBoardsDescById()	updateBoardsDescByIdBoard()	PUT /boards/{idBoard}/desc
BoardsEmailKeyGenerate::addBoardsEmailKeyGenerateById()	addBoardsEmailKeyGenerateByIdBoard()	POST /boards/{idBoard}/emailKey/generate
BoardsIdOrganization::updateBoardsIdOrganizationById()	updateBoardsIdOrganizationByIdBoard()	PUT /boards/{idBoard}/idOrganization
BoardsLabelNamesBlue::updateBoardsLabelNamesBlueById()	updateBoardsLabelNamesBlueByIdBoard()	PUT /boards/{idBoard}/labelNames/blue
BoardsLabelNamesGreen::updateBoardsLabelNamesGreenById()	updateBoardsLabelNamesGreenByIdBoard()	PUT /boards/{idBoard}/labelNames/green
BoardsLabelNamesOrange::updateBoardsLabelNamesOrangeById()	updateBoardsLabelNamesOrangeByIdBoard()	PUT /boards/{idBoard}/labelNames/orange
BoardsLabelNamesPurple::updateBoardsLabelNamesPurpleById()	updateBoardsLabelNamesPurpleByIdBoard()	PUT /boards/{idBoard}/labelNames/purple
BoardsLabelNamesRed::updateBoardsLabelNamesRedById()	updateBoardsLabelNamesRedByIdBoard()	PUT /boards/{idBoard}/labelNames/red
BoardsLabelNamesYellow::updateBoardsLabelNamesYellowById()	updateBoardsLabelNamesYellowByIdBoard()	PUT /boards/{idBoard}/labelNames/yellow
BoardsLabels::getBoardsLabelsById()	getBoardsLabelsByIdBoard()	GET /boards/{idBoard}/labels
BoardsLabels::addBoardsLabelsById()	addBoardsLabelsByIdBoard()	POST /boards/{idBoard}/labels
BoardsLabels::getBoardsLabelsByIdBoardById()	getBoardsLabelsByIdBoardByIdLabel()	GET /boards/{idBoard}/labels/{idLabel}
BoardsLists::getBoardsListsById()	getBoardsListsByIdBoard()	GET /boards/{idBoard}/lists
BoardsLists::addBoardsListsById()	addBoardsListsByIdBoard()	POST /boards/{idBoard}/lists
BoardsLists::getBoardsListsByIdBoardByFilter()	getBoardsListsByIdBoardByFilter()	GET /boards/{idBoard}/lists/{filter}
BoardsMarkAsViewed::addBoardsMarkAsViewedById()	addBoardsMarkAsViewedByIdBoard()	POST /boards/{idBoard}/markAsViewed
BoardsMembers::getBoardsMembersById()	getBoardsMembersByIdBoard()	GET /boards/{idBoard}/members
BoardsMembers::updateBoardsMembersById()	updateBoardsMembersByIdBoard()	PUT /boards/{idBoard}/members
BoardsMembers::getBoardsMembersByIdBoardByFilter()	getBoardsMembersByIdBoardByFilter()	GET /boards/{idBoard}/members/{filter}
BoardsMembers::updateBoardsMembersByIdBoardById()	updateBoardsMembersByIdBoardByIdMember()	PUT /boards/{idBoard}/members/{idMember}
BoardsMembers::deleteBoardsMembersByIdBoardById()	deleteBoardsMembersByIdBoardByIdMember()	DELETE /boards/{idBoard}/members/{idMember}
BoardsMembersCards::getBoardsMembersCardsByIdBoardById()	getBoardsMembersCardsByIdBoardByIdMember()	GET /boards/{idBoard}/members/{idMember}/cards
BoardsMembersInvited::getBoardsMembersInvitedById()	getBoardsMembersInvitedByIdBoard()	GET /boards/{idBoard}/membersInvited
BoardsMembersInvited::getBoardsMembersInvitedByIdBoardByField()	getBoardsMembersInvitedByIdBoardByField()	GET /boards/{idBoard}/membersInvited/{field}
BoardsMemberships::getBoardsMembershipsById()	getBoardsMembershipsByIdBoard()	GET /boards/{idBoard}/memberships
BoardsMemberships::getBoardsMembershipsByIdBoardById()	getBoardsMembershipsByIdBoardByIdMembership()	GET /boards/{idBoard}/memberships/{idMembership}
BoardsMemberships::updateBoardsMembershipsByIdBoardById()	updateBoardsMembershipsByIdBoardByIdMembership()	PUT /boards/{idBoard}/memberships/{idMembership}
BoardsMyPrefs::getBoardsMyPrefsById()	getBoardsMyPrefsByIdBoard()	GET /boards/{idBoard}/myPrefs
BoardsMyPrefsEmailPosition::updateBoardsMyPrefsEmailPositionById()	updateBoardsMyPrefsEmailPositionByIdBoard()	PUT /boards/{idBoard}/myPrefs/emailPosition
BoardsMyPrefsIdEmailList::updateBoardsMyPrefsIdEmailListById()	updateBoardsMyPrefsIdEmailListByIdBoard()	PUT /boards/{idBoard}/myPrefs/idEmailList
BoardsMyPrefsShowListGuide::updateBoardsMyPrefsShowListGuideById()	updateBoardsMyPrefsShowListGuideByIdBoard()	PUT /boards/{idBoard}/myPrefs/showListGuide
BoardsMyPrefsShowSidebar::updateBoardsMyPrefsShowSidebarById()	updateBoardsMyPrefsShowSidebarByIdBoard()	PUT /boards/{idBoard}/myPrefs/showSidebar
BoardsMyPrefsShowSidebarActivity::updateBoardsMyPrefsShowSidebarActivityById()	updateBoardsMyPrefsShowSidebarActivityByIdBoard()	PUT /boards/{idBoard}/myPrefs/showSidebarActivity
BoardsMyPrefsShowSidebarBoardActions::updateBoardsMyPrefsShowSidebarBoardActionsById()	updateBoardsMyPrefsShowSidebarBoardActionsByIdBoard()	PUT /boards/{idBoard}/myPrefs/showSidebarBoardActions
BoardsMyPrefsShowSidebarMembers::updateBoardsMyPrefsShowSidebarMembersById()	updateBoardsMyPrefsShowSidebarMembersByIdBoard()	PUT /boards/{idBoard}/myPrefs/showSidebarMembers
BoardsName::updateBoardsNameById()	updateBoardsNameByIdBoard()	PUT /boards/{idBoard}/name
BoardsOrganization::getBoardsOrganizationById()	getBoardsOrganizationByIdBoard()	GET /boards/{idBoard}/organization
BoardsOrganization::getBoardsOrganizationByIdBoardByField()	getBoardsOrganizationByIdBoardByField()	GET /boards/{idBoard}/organization/{field}
BoardsPowerUps::addBoardsPowerUpsById()	addBoardsPowerUpsByIdBoard()	POST /boards/{idBoard}/powerUps
BoardsPowerUps::deleteBoardsPowerUpsByIdBoardBy()	deleteBoardsPowerUpsByIdBoardByPowerUp()	DELETE /boards/{idBoard}/powerUps/{powerUp}
BoardsPrefsBackground::updateBoardsPrefsBackgroundById()	updateBoardsPrefsBackgroundByIdBoard()	PUT /boards/{idBoard}/prefs/background
BoardsPrefsCalendarFeedEnabled::updateBoardsPrefsCalendarFeedEnabledById()	updateBoardsPrefsCalendarFeedEnabledByIdBoard()	PUT /boards/{idBoard}/prefs/calendarFeedEnabled
BoardsPrefsCardAging::updateBoardsPrefsCardAgingById()	updateBoardsPrefsCardAgingByIdBoard()	PUT /boards/{idBoard}/prefs/cardAging
BoardsPrefsCardCovers::updateBoardsPrefsCardCoversById()	updateBoardsPrefsCardCoversByIdBoard()	PUT /boards/{idBoard}/prefs/cardCovers
BoardsPrefsComments::updateBoardsPrefsCommentsById()	updateBoardsPrefsCommentsByIdBoard()	PUT /boards/{idBoard}/prefs/comments
BoardsPrefsInvitations::updateBoardsPrefsInvitationsById()	updateBoardsPrefsInvitationsByIdBoard()	PUT /boards/{idBoard}/prefs/invitations
BoardsPrefsPermissionLevel::updateBoardsPrefsPermissionLevelById()	updateBoardsPrefsPermissionLevelByIdBoard()	PUT /boards/{idBoard}/prefs/permissionLevel
BoardsPrefsSelfJoin::updateBoardsPrefsSelfJoinById()	updateBoardsPrefsSelfJoinByIdBoard()	PUT /boards/{idBoard}/prefs/selfJoin
BoardsPrefsVoting::updateBoardsPrefsVotingById()	updateBoardsPrefsVotingByIdBoard()	PUT /boards/{idBoard}/prefs/voting
BoardsSubscribed::updateBoardsSubscribedById()	updateBoardsSubscribedByIdBoard()	PUT /boards/{idBoard}/subscribed
Cards::add()	addCards()	POST /cards
Cards::getCardsById()	getCardsByIdCard()	GET /cards/{idCard}
Cards::updateCardsById()	updateCardsByIdCard()	PUT /cards/{idCard}
Cards::deleteCardsById()	deleteCardsByIdCard()	DELETE /cards/{idCard}
Cards::getCardsByIdCardByField()	getCardsByIdCardByField()	GET /cards/{idCard}/{field}
CardsActions::getCardsActionsById()	getCardsActionsByIdCard()	GET /cards/{idCard}/actions
CardsActionsComments::addCardsActionsCommentsById()	addCardsActionsCommentsByIdCard()	POST /cards/{idCard}/actions/comments
CardsActionsComments::updateCardsActionsCommentsByIdCardById()	updateCardsActionsCommentsByIdCardByIdAction()	PUT /cards/{idCard}/actions/{idAction}/comments
CardsActionsComments::deleteCardsActionsCommentsByIdCardById()	deleteCardsActionsCommentsByIdCardByIdAction()	DELETE /cards/{idCard}/actions/{idAction}/comments
CardsAttachments::getCardsAttachmentsById()	getCardsAttachmentsByIdCard()	GET /cards/{idCard}/attachments
CardsAttachments::addCardsAttachmentsById()	addCardsAttachmentsByIdCard()	POST /cards/{idCard}/attachments
CardsAttachments::getCardsAttachmentsByIdCardById()	getCardsAttachmentsByIdCardByIdAttachment()	GET /cards/{idCard}/attachments/{idAttachment}
CardsAttachments::deleteCardsAttachmentsByIdCardById()	deleteCardsAttachmentsByIdCardByIdAttachment()	DELETE /cards/{idCard}/attachments/{idAttachment}
CardsBoard::getCardsBoardById()	getCardsBoardByIdCard()	GET /cards/{idCard}/board
CardsBoard::getCardsBoardByIdCardByField()	getCardsBoardByIdCardByField()	GET /cards/{idCard}/board/{field}
CardsCheckItemStates::getCardsCheckItemStatesById()	getCardsCheckItemStatesByIdCard()	GET /cards/{idCard}/checkItemStates
CardsChecklistCheckItem::updateCardsChecklistCheckItemByIdCardByIdChecklistCurrentById()	updateCardsChecklistCheckItemByIdCardByIdChecklistCurrentByIdCheckItem()	PUT /cards/{idCard}/checklist/{idChecklistCurrent}/checkItem/{idCheckItem}
CardsChecklistCheckItem::addCardsChecklistCheckItemByIdCardById()	addCardsChecklistCheckItemByIdCardByIdChecklist()	POST /cards/{idCard}/checklist/{idChecklist}/checkItem
CardsChecklistCheckItem::deleteCardsChecklistCheckItemByIdCardByIdChecklistById()	deleteCardsChecklistCheckItemByIdCardByIdChecklistByIdCheckItem()	DELETE /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}
CardsChecklistCheckItemConvertToCard::addCardsChecklistCheckItemConvertToCardByIdCardByIdChecklistById()	addCardsChecklistCheckItemConvertToCardByIdCardByIdChecklistByIdCheckItem()	POST /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/convertToCard
CardsChecklistCheckItemName::updateCardsChecklistCheckItemNameByIdCardByIdChecklistById()	updateCardsChecklistCheckItemNameByIdCardByIdChecklistByIdCheckItem()	PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/name
CardsChecklistCheckItemPos::updateCardsChecklistCheckItemPosByIdCardByIdChecklistById()	updateCardsChecklistCheckItemPosByIdCardByIdChecklistByIdCheckItem()	PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/pos
CardsChecklistCheckItemState::updateCardsChecklistCheckItemStateByIdCardByIdChecklistById()	updateCardsChecklistCheckItemStateByIdCardByIdChecklistByIdCheckItem()	PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/state
CardsChecklists::getCardsChecklistsById()	getCardsChecklistsByIdCard()	GET /cards/{idCard}/checklists
CardsChecklists::addCardsChecklistsById()	addCardsChecklistsByIdCard()	POST /cards/{idCard}/checklists
CardsChecklists::deleteCardsChecklistsByIdCardById()	deleteCardsChecklistsByIdCardByIdChecklist()	DELETE /cards/{idCard}/checklists/{idChecklist}
CardsClosed::updateCardsClosedById()	updateCardsClosedByIdCard()	PUT /cards/{idCard}/closed
CardsDesc::updateCardsDescById()	updateCardsDescByIdCard()	PUT /cards/{idCard}/desc
CardsDue::updateCardsDueById()	updateCardsDueByIdCard()	PUT /cards/{idCard}/due
CardsIdAttachmentCover::updateCardsIdAttachmentCoverById()	updateCardsIdAttachmentCoverByIdCard()	PUT /cards/{idCard}/idAttachmentCover
CardsIdBoard::updateCardsIdBoardById()	updateCardsIdBoardByIdCard()	PUT /cards/{idCard}/idBoard
CardsIdLabels::addCardsIdLabelsById()	addCardsIdLabelsByIdCard()	POST /cards/{idCard}/idLabels
CardsIdLabels::deleteCardsIdLabelsByIdCardBy()	deleteCardsIdLabelsByIdCardByIdLabel()	DELETE /cards/{idCard}/idLabels/{idLabel}
CardsIdList::updateCardsIdListById()	updateCardsIdListByIdCard()	PUT /cards/{idCard}/idList
CardsIdMembers::updateCardsIdMembersById()	updateCardsIdMembersByIdCard()	PUT /cards/{idCard}/idMembers
CardsIdMembers::addCardsIdMembersById()	addCardsIdMembersByIdCard()	POST /cards/{idCard}/idMembers
CardsIdMembers::deleteCardsIdMembersByIdCardBy()	deleteCardsIdMembersByIdCardByIdMember()	DELETE /cards/{idCard}/idMembers/{idMember}
CardsLabels::updateCardsLabelsById()	updateCardsLabelsByIdCard()	PUT /cards/{idCard}/labels
CardsLabels::addCardsLabelsById()	addCardsLabelsByIdCard()	POST /cards/{idCard}/labels
CardsLabels::deleteCardsLabelsByIdCardByColor()	deleteCardsLabelsByIdCardByColor()	DELETE /cards/{idCard}/labels/{color}
CardsList::getCardsListById()	getCardsListByIdCard()	GET /cards/{idCard}/list
CardsList::getCardsListByIdCardByField()	getCardsListByIdCardByField()	GET /cards/{idCard}/list/{field}
CardsMarkAssociatedNotificationsRead::addCardsMarkAssociatedNotificationsReadById()	addCardsMarkAssociatedNotificationsReadByIdCard()	POST /cards/{idCard}/markAssociatedNotificationsRead
CardsMembers::getCardsMembersById()	getCardsMembersByIdCard()	GET /cards/{idCard}/members
CardsMembersVoted::getCardsMembersVotedById()	getCardsMembersVotedByIdCard()	GET /cards/{idCard}/membersVoted
CardsMembersVoted::addCardsMembersVotedById()	addCardsMembersVotedByIdCard()	POST /cards/{idCard}/membersVoted
CardsMembersVoted::deleteCardsMembersVotedByIdCardByIdMember()	deleteCardsMembersVotedByIdCardByIdMember()	DELETE /cards/{idCard}/membersVoted/{idMember}
CardsName::updateCardsNameById()	updateCardsNameByIdCard()	PUT /cards/{idCard}/name
CardsPos::updateCardsPosById()	updateCardsPosByIdCard()	PUT /cards/{idCard}/pos
CardsStickers::getCardsStickersById()	getCardsStickersByIdCard()	GET /cards/{idCard}/stickers
CardsStickers::addCardsStickersById()	addCardsStickersByIdCard()	POST /cards/{idCard}/stickers
CardsStickers::getCardsStickersByIdCardById()	getCardsStickersByIdCardByIdSticker()	GET /cards/{idCard}/stickers/{idSticker}
CardsStickers::updateCardsStickersByIdCardById()	updateCardsStickersByIdCardByIdSticker()	PUT /cards/{idCard}/stickers/{idSticker}
CardsStickers::deleteCardsStickersByIdCardById()	deleteCardsStickersByIdCardByIdSticker()	DELETE /cards/{idCard}/stickers/{idSticker}
CardsSubscribed::updateCardsSubscribedById()	updateCardsSubscribedByIdCard()	PUT /cards/{idCard}/subscribed
Checklists::add()	addChecklists()	POST /checklists
Checklists::getChecklistsById()	getChecklistsByIdChecklist()	GET /checklists/{idChecklist}
Checklists::updateChecklistsById()	updateChecklistsByIdChecklist()	PUT /checklists/{idChecklist}
Checklists::deleteChecklistsById()	deleteChecklistsByIdChecklist()	DELETE /checklists/{idChecklist}
Checklists::getChecklistsByIdChecklistByField()	getChecklistsByIdChecklistByField()	GET /checklists/{idChecklist}/{field}
ChecklistsBoard::getChecklistsBoardById()	getChecklistsBoardByIdChecklist()	GET /checklists/{idChecklist}/board
ChecklistsBoard::getChecklistsBoardByIdChecklistByField()	getChecklistsBoardByIdChecklistByField()	GET /checklists/{idChecklist}/board/{field}
ChecklistsCards::getChecklistsCardsById()	getChecklistsCardsByIdChecklist()	GET /checklists/{idChecklist}/cards
ChecklistsCards::getChecklistsCardsByIdChecklistByFilter()	getChecklistsCardsByIdChecklistByFilter()	GET /checklists/{idChecklist}/cards/{filter}
ChecklistsCheckItems::getChecklistsCheckItemsById()	getChecklistsCheckItemsByIdChecklist()	GET /checklists/{idChecklist}/checkItems
ChecklistsCheckItems::addChecklistsCheckItemsById()	addChecklistsCheckItemsByIdChecklist()	POST /checklists/{idChecklist}/checkItems
ChecklistsCheckItems::getChecklistsCheckItemsByIdChecklistById()	getChecklistsCheckItemsByIdChecklistByIdCheckItem()	GET /checklists/{idChecklist}/checkItems/{idCheckItem}
ChecklistsCheckItems::deleteChecklistsCheckItemsByIdChecklistById()	deleteChecklistsCheckItemsByIdChecklistByIdCheckItem()	DELETE /checklists/{idChecklist}/checkItems/{idCheckItem}
ChecklistsIdCard::updateChecklistsIdCardById()	updateChecklistsIdCardByIdChecklist()	PUT /checklists/{idChecklist}/idCard
ChecklistsName::updateChecklistsNameById()	updateChecklistsNameByIdChecklist()	PUT /checklists/{idChecklist}/name
ChecklistsPos::updateChecklistsPosById()	updateChecklistsPosByIdChecklist()	PUT /checklists/{idChecklist}/pos
Labels::add()	addLabels()	POST /labels
Labels::getLabelsById()	getLabelsByIdLabel()	GET /labels/{idLabel}
Labels::updateLabelsById()	updateLabelsByIdLabel()	PUT /labels/{idLabel}
Labels::deleteLabelsById()	deleteLabelsByIdLabel()	DELETE /labels/{idLabel}
LabelsBoard::getLabelsBoardById()	getLabelsBoardByIdLabel()	GET /labels/{idLabel}/board
LabelsBoard::getLabelsBoardByIdLabelByField()	getLabelsBoardByIdLabelByField()	GET /labels/{idLabel}/board/{field}
LabelsColor::updateLabelsColorById()	updateLabelsColorByIdLabel()	PUT /labels/{idLabel}/color
LabelsName::updateLabelsNameById()	updateLabelsNameByIdLabel()	PUT /labels/{idLabel}/name
Lists::add()	addLists()	POST /lists
Lists::getListsById()	getListsByIdList()	GET /lists/{idList}
Lists::updateListsById()	updateListsByIdList()	PUT /lists/{idList}
Lists::getListsByIdListByField()	getListsByIdListByField()	GET /lists/{idList}/{field}
ListsActions::getListsActionsById()	getListsActionsByIdList()	GET /lists/{idList}/actions
ListsArchiveAllCards::addListsArchiveAllCardsById()	addListsArchiveAllCardsByIdList()	POST /lists/{idList}/archiveAllCards
ListsBoard::getListsBoardById()	getListsBoardByIdList()	GET /lists/{idList}/board
ListsBoard::getListsBoardByIdListByField()	getListsBoardByIdListByField()	GET /lists/{idList}/board/{field}
ListsCards::getListsCardsById()	getListsCardsByIdList()	GET /lists/{idList}/cards
ListsCards::addListsCardsById()	addListsCardsByIdList()	POST /lists/{idList}/cards
ListsCards::getListsCardsByIdListByFilter()	getListsCardsByIdListByFilter()	GET /lists/{idList}/cards/{filter}
ListsClosed::updateListsClosedById()	updateListsClosedByIdList()	PUT /lists/{idList}/closed
ListsIdBoard::updateListsIdBoardById()	updateListsIdBoardByIdList()	PUT /lists/{idList}/idBoard
ListsMoveAllCards::addListsMoveAllCardsById()	addListsMoveAllCardsByIdList()	POST /lists/{idList}/moveAllCards
ListsName::updateListsNameById()	updateListsNameByIdList()	PUT /lists/{idList}/name
ListsPos::updateListsPosById()	updateListsPosByIdList()	PUT /lists/{idList}/pos
ListsSubscribed::updateListsSubscribedById()	updateListsSubscribedByIdList()	PUT /lists/{idList}/subscribed
Members::getMembersById()	getMembersByIdMember()	GET /members/{idMember}
Members::updateMembersById()	updateMembersByIdMember()	PUT /members/{idMember}
Members::getMembersByIdMemberByField()	getMembersByIdMemberByField()	GET /members/{idMember}/{field}
MembersActions::getMembersActionsById()	getMembersActionsByIdMember()	GET /members/{idMember}/actions
MembersAvatar::addMembersAvatarById()	addMembersAvatarByIdMember()	POST /members/{idMember}/avatar
MembersAvatarSource::updateMembersAvatarSourceById()	updateMembersAvatarSourceByIdMember()	PUT /members/{idMember}/avatarSource
MembersBio::updateMembersBioById()	updateMembersBioByIdMember()	PUT /members/{idMember}/bio
MembersBoardBackgrounds::getMembersBoardBackgroundsById()	getMembersBoardBackgroundsByIdMember()	GET /members/{idMember}/boardBackgrounds
MembersBoardBackgrounds::addMembersBoardBackgroundsById()	addMembersBoardBackgroundsByIdMember()	POST /members/{idMember}/boardBackgrounds
MembersBoardBackgrounds::getMembersBoardBackgroundsByIdMemberById()	getMembersBoardBackgroundsByIdMemberByIdBoardBackground()	GET /members/{idMember}/boardBackgrounds/{idBoardBackground}
MembersBoardBackgrounds::updateMembersBoardBackgroundsByIdMemberById()	updateMembersBoardBackgroundsByIdMemberByIdBoardBackground()	PUT /members/{idMember}/boardBackgrounds/{idBoardBackground}
MembersBoardBackgrounds::deleteMembersBoardBackgroundsByIdMemberById()	deleteMembersBoardBackgroundsByIdMemberByIdBoardBackground()	DELETE /members/{idMember}/boardBackgrounds/{idBoardBackground}
MembersBoardStars::getMembersBoardStarsById()	getMembersBoardStarsByIdMember()	GET /members/{idMember}/boardStars
MembersBoardStars::addMembersBoardStarsById()	addMembersBoardStarsByIdMember()	POST /members/{idMember}/boardStars
MembersBoardStars::getMembersBoardStarsByIdMemberById()	getMembersBoardStarsByIdMemberByIdBoardStar()	GET /members/{idMember}/boardStars/{idBoardStar}
MembersBoardStars::updateMembersBoardStarsByIdMemberById()	updateMembersBoardStarsByIdMemberByIdBoardStar()	PUT /members/{idMember}/boardStars/{idBoardStar}
MembersBoardStars::deleteMembersBoardStarsByIdMemberById()	deleteMembersBoardStarsByIdMemberByIdBoardStar()	DELETE /members/{idMember}/boardStars/{idBoardStar}
MembersBoardStarsIdBoard::updateMembersBoardStarsIdBoardByIdMemberById()	updateMembersBoardStarsIdBoardByIdMemberByIdBoardStar()	PUT /members/{idMember}/boardStars/{idBoardStar}/idBoard
MembersBoardStarsPos::updateMembersBoardStarsPosByIdMemberById()	updateMembersBoardStarsPosByIdMemberByIdBoardStar()	PUT /members/{idMember}/boardStars/{idBoardStar}/pos
MembersBoards::getMembersBoardsById()	getMembersBoardsByIdMember()	GET /members/{idMember}/boards
MembersBoards::getMembersBoardsByIdMemberByFilter()	getMembersBoardsByIdMemberByFilter()	GET /members/{idMember}/boards/{filter}
MembersBoardsInvited::getMembersBoardsInvitedById()	getMembersBoardsInvitedByIdMember()	GET /members/{idMember}/boardsInvited
MembersBoardsInvited::getMembersBoardsInvitedByIdMemberByField()	getMembersBoardsInvitedByIdMemberByField()	GET /members/{idMember}/boardsInvited/{field}
MembersCards::getMembersCardsById()	getMembersCardsByIdMember()	GET /members/{idMember}/cards
MembersCards::getMembersCardsByIdMemberByFilter()	getMembersCardsByIdMemberByFilter()	GET /members/{idMember}/cards/{filter}
MembersCustomBoardBackgrounds::getMembersCustomBoardBackgroundsById()	getMembersCustomBoardBackgroundsByIdMember()	GET /members/{idMember}/customBoardBackgrounds
MembersCustomBoardBackgrounds::addMembersCustomBoardBackgroundsById()	addMembersCustomBoardBackgroundsByIdMember()	POST /members/{idMember}/customBoardBackgrounds
MembersCustomBoardBackgrounds::getMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground()	getMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground()	GET /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
MembersCustomBoardBackgrounds::updateMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground()	updateMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground()	PUT /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
MembersCustomBoardBackgrounds::deleteMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground()	deleteMembersCustomBoardBackgroundsByIdMemberByIdBoardBackground()	DELETE /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
MembersCustomEmoji::getMembersCustomEmojiById()	getMembersCustomEmojiByIdMember()	GET /members/{idMember}/customEmoji
MembersCustomEmoji::addMembersCustomEmojiById()	addMembersCustomEmojiByIdMember()	POST /members/{idMember}/customEmoji
MembersCustomEmoji::getMembersCustomEmojiByIdMemberById()	getMembersCustomEmojiByIdMemberByIdCustomEmoji()	GET /members/{idMember}/customEmoji/{idCustomEmoji}
MembersCustomStickers::getMembersCustomStickersById()	getMembersCustomStickersByIdMember()	GET /members/{idMember}/customStickers
MembersCustomStickers::addMembersCustomStickersById()	addMembersCustomStickersByIdMember()	POST /members/{idMember}/customStickers
MembersCustomStickers::getMembersCustomStickersByIdMemberById()	getMembersCustomStickersByIdMemberByIdCustomSticker()	GET /members/{idMember}/customStickers/{idCustomSticker}
MembersCustomStickers::deleteMembersCustomStickersByIdMemberById()	deleteMembersCustomStickersByIdMemberByIdCustomSticker()	DELETE /members/{idMember}/customStickers/{idCustomSticker}
MembersDeltas::getMembersDeltasById()	getMembersDeltasByIdMember()	GET /members/{idMember}/deltas
MembersFullName::updateMembersFullNameById()	updateMembersFullNameByIdMember()	PUT /members/{idMember}/fullName
MembersInitials::updateMembersInitialsById()	updateMembersInitialsByIdMember()	PUT /members/{idMember}/initials
MembersNotifications::getMembersNotificationsById()	getMembersNotificationsByIdMember()	GET /members/{idMember}/notifications
MembersNotifications::getMembersNotificationsByIdMemberByFilter()	getMembersNotificationsByIdMemberByFilter()	GET /members/{idMember}/notifications/{filter}
MembersOneTimeMessagesDismissed::addMembersOneTimeMessagesDismissedById()	addMembersOneTimeMessagesDismissedByIdMember()	POST /members/{idMember}/oneTimeMessagesDismissed
MembersOrganizations::getMembersOrganizationsById()	getMembersOrganizationsByIdMember()	GET /members/{idMember}/organizations
MembersOrganizations::getMembersOrganizationsByIdMemberByFilter()	getMembersOrganizationsByIdMemberByFilter()	GET /members/{idMember}/organizations/{filter}
MembersOrganizationsInvited::getMembersOrganizationsInvitedById()	getMembersOrganizationsInvitedByIdMember()	GET /members/{idMember}/organizationsInvited
MembersOrganizationsInvited::getMembersOrganizationsInvitedByIdMemberByField()	getMembersOrganizationsInvitedByIdMemberByField()	GET /members/{idMember}/organizationsInvited/{field}
MembersPrefsColorBlind::updateMembersPrefsColorBlindById()	updateMembersPrefsColorBlindByIdMember()	PUT /members/{idMember}/prefs/colorBlind
MembersPrefsLocale::updateMembersPrefsLocaleById()	updateMembersPrefsLocaleByIdMember()	PUT /members/{idMember}/prefs/locale
MembersPrefsMinutesBetweenSummaries::updateMembersPrefsMinutesBetweenSummariesById()	updateMembersPrefsMinutesBetweenSummariesByIdMember()	PUT /members/{idMember}/prefs/minutesBetweenSummaries
MembersSavedSearches::getMembersSavedSearchesById()	getMembersSavedSearchesByIdMember()	GET /members/{idMember}/savedSearches
MembersSavedSearches::addMembersSavedSearchesById()	addMembersSavedSearchesByIdMember()	POST /members/{idMember}/savedSearches
MembersSavedSearches::getMembersSavedSearchesByIdMemberByIdSavedSearch()	getMembersSavedSearchesByIdMemberByIdSavedSearch()	GET /members/{idMember}/savedSearches/{idSavedSearch}
MembersSavedSearches::updateMembersSavedSearchesByIdMemberByIdSavedSearch()	updateMembersSavedSearchesByIdMemberByIdSavedSearch()	PUT /members/{idMember}/savedSearches/{idSavedSearch}
MembersSavedSearches::deleteMembersSavedSearchesByIdMemberByIdSavedSearch()	deleteMembersSavedSearchesByIdMemberByIdSavedSearch()	DELETE /members/{idMember}/savedSearches/{idSavedSearch}
MembersSavedSearchesName::updateMembersSavedSearchesNameByIdMemberByIdSavedSearch()	updateMembersSavedSearchesNameByIdMemberByIdSavedSearch()	PUT /members/{idMember}/savedSearches/{idSavedSearch}/name
MembersSavedSearchesPos::updateMembersSavedSearchesPosByIdMemberByIdSavedSearch()	updateMembersSavedSearchesPosByIdMemberByIdSavedSearch()	PUT /members/{idMember}/savedSearches/{idSavedSearch}/pos
MembersSavedSearchesQuery::updateMembersSavedSearchesQueryByIdMemberByIdSavedSearch()	updateMembersSavedSearchesQueryByIdMemberByIdSavedSearch()	PUT /members/{idMember}/savedSearches/{idSavedSearch}/query
MembersTokens::getMembersTokensById()	getMembersTokensByIdMember()	GET /members/{idMember}/tokens
MembersUsername::updateMembersUsernameById()	updateMembersUsernameByIdMember()	PUT /members/{idMember}/username
Notifications::getNotificationsById()	getNotificationsByIdNotification()	GET /notifications/{idNotification}
Notifications::updateNotificationsById()	updateNotificationsByIdNotification()	PUT /notifications/{idNotification}
Notifications::getNotificationsByIdNotificationByField()	getNotificationsByIdNotificationByField()	GET /notifications/{idNotification}/{field}
NotificationsAllRead::add()	addNotificationsAllRead()	POST /notifications/all/read
NotificationsBoard::getNotificationsBoardById()	getNotificationsBoardByIdNotification()	GET /notifications/{idNotification}/board
NotificationsBoard::getNotificationsBoardByIdNotificationByField()	getNotificationsBoardByIdNotificationByField()	GET /notifications/{idNotification}/board/{field}
NotificationsCard::getNotificationsCardById()	getNotificationsCardByIdNotification()	GET /notifications/{idNotification}/card
NotificationsCard::getNotificationsCardByIdNotificationByField()	getNotificationsCardByIdNotificationByField()	GET /notifications/{idNotification}/card/{field}
NotificationsDisplay::getNotificationsDisplayById()	getNotificationsDisplayByIdNotification()	GET /notifications/{idNotification}/display
NotificationsEntities::getNotificationsEntitiesById()	getNotificationsEntitiesByIdNotification()	GET /notifications/{idNotification}/entities
NotificationsList::getNotificationsListById()	getNotificationsListByIdNotification()	GET /notifications/{idNotification}/list
NotificationsList::getNotificationsListByIdNotificationByField()	getNotificationsListByIdNotificationByField()	GET /notifications/{idNotification}/list/{field}
NotificationsMember::getNotificationsMemberById()	getNotificationsMemberByIdNotification()	GET /notifications/{idNotification}/member
NotificationsMember::getNotificationsMemberByIdNotificationByField()	getNotificationsMemberByIdNotificationByField()	GET /notifications/{idNotification}/member/{field}
NotificationsMemberCreator::getNotificationsMemberCreatorById()	getNotificationsMemberCreatorByIdNotification()	GET /notifications/{idNotification}/memberCreator
NotificationsMemberCreator::getNotificationsMemberCreatorByIdNotificationByField()	getNotificationsMemberCreatorByIdNotificationByField()	GET /notifications/{idNotification}/memberCreator/{field}
NotificationsOrganization::getNotificationsOrganizationById()	getNotificationsOrganizationByIdNotification()	GET /notifications/{idNotification}/organization
NotificationsOrganization::getNotificationsOrganizationByIdNotificationByField()	getNotificationsOrganizationByIdNotificationByField()	GET /notifications/{idNotification}/organization/{field}
NotificationsUnread::updateNotificationsUnreadById()	updateNotificationsUnreadByIdNotification()	PUT /notifications/{idNotification}/unread
Organizations::add()	addOrganizations()	POST /organizations
Organizations::getOrganizationsByIdOrg()	getOrganizationsByIdOrg()	GET /organizations/{idOrg}
Organizations::updateOrganizationsByIdOrg()	updateOrganizationsByIdOrg()	PUT /organizations/{idOrg}
Organizations::deleteOrganizationsByIdOrg()	deleteOrganizationsByIdOrg()	DELETE /organizations/{idOrg}
Organizations::getOrganizationsByIdOrgByField()	getOrganizationsByIdOrgByField()	GET /organizations/{idOrg}/{field}
OrganizationsActions::getOrganizationsActionsByIdOrg()	getOrganizationsActionsByIdOrg()	GET /organizations/{idOrg}/actions
OrganizationsBoards::getOrganizationsBoardsByIdOrg()	getOrganizationsBoardsByIdOrg()	GET /organizations/{idOrg}/boards
OrganizationsBoards::getOrganizationsBoardsByIdOrgByFilter()	getOrganizationsBoardsByIdOrgByFilter()	GET /organizations/{idOrg}/boards/{filter}
OrganizationsDeltas::getOrganizationsDeltasByIdOrg()	getOrganizationsDeltasByIdOrg()	GET /organizations/{idOrg}/deltas
OrganizationsDesc::updateOrganizationsDescByIdOrg()	updateOrganizationsDescByIdOrg()	PUT /organizations/{idOrg}/desc
OrganizationsDisplayName::updateOrganizationsDisplayNameByIdOrg()	updateOrganizationsDisplayNameByIdOrg()	PUT /organizations/{idOrg}/displayName
OrganizationsLogo::addOrganizationsLogoByIdOrg()	addOrganizationsLogoByIdOrg()	POST /organizations/{idOrg}/logo
OrganizationsLogo::deleteOrganizationsLogoByIdOrg()	deleteOrganizationsLogoByIdOrg()	DELETE /organizations/{idOrg}/logo
OrganizationsMembers::getOrganizationsMembersByIdOrg()	getOrganizationsMembersByIdOrg()	GET /organizations/{idOrg}/members
OrganizationsMembers::updateOrganizationsMembersByIdOrg()	updateOrganizationsMembersByIdOrg()	PUT /organizations/{idOrg}/members
OrganizationsMembers::getOrganizationsMembersByIdOrgByFilter()	getOrganizationsMembersByIdOrgByFilter()	GET /organizations/{idOrg}/members/{filter}
OrganizationsMembers::updateOrganizationsMembersByIdOrgById()	updateOrganizationsMembersByIdOrgByIdMember()	PUT /organizations/{idOrg}/members/{idMember}
OrganizationsMembers::deleteOrganizationsMembersByIdOrgById()	deleteOrganizationsMembersByIdOrgByIdMember()	DELETE /organizations/{idOrg}/members/{idMember}
OrganizationsMembersAll::deleteOrganizationsMembersAllByIdOrgById()	deleteOrganizationsMembersAllByIdOrgByIdMember()	DELETE /organizations/{idOrg}/members/{idMember}/all
OrganizationsMembersCards::getOrganizationsMembersCardsByIdOrgById()	getOrganizationsMembersCardsByIdOrgByIdMember()	GET /organizations/{idOrg}/members/{idMember}/cards
OrganizationsMembersDeactivated::updateOrganizationsMembersDeactivatedByIdOrgById()	updateOrganizationsMembersDeactivatedByIdOrgByIdMember()	PUT /organizations/{idOrg}/members/{idMember}/deactivated
OrganizationsMembersInvited::getOrganizationsMembersInvitedByIdOrg()	getOrganizationsMembersInvitedByIdOrg()	GET /organizations/{idOrg}/membersInvited
OrganizationsMembersInvited::getOrganizationsMembersInvitedByIdOrgByField()	getOrganizationsMembersInvitedByIdOrgByField()	GET /organizations/{idOrg}/membersInvited/{field}
OrganizationsMemberships::getOrganizationsMembershipsByIdOrg()	getOrganizationsMembershipsByIdOrg()	GET /organizations/{idOrg}/memberships
OrganizationsMemberships::getOrganizationsMembershipsByIdOrgById()	getOrganizationsMembershipsByIdOrgByIdMembership()	GET /organizations/{idOrg}/memberships/{idMembership}
OrganizationsMemberships::updateOrganizationsMembershipsByIdOrgById()	updateOrganizationsMembershipsByIdOrgByIdMembership()	PUT /organizations/{idOrg}/memberships/{idMembership}
OrganizationsName::updateOrganizationsNameByIdOrg()	updateOrganizationsNameByIdOrg()	PUT /organizations/{idOrg}/name
OrganizationsPrefsAssociatedDomain::updateOrganizationsPrefsAssociatedDomainByIdOrg()	updateOrganizationsPrefsAssociatedDomainByIdOrg()	PUT /organizations/{idOrg}/prefs/associatedDomain
OrganizationsPrefsAssociatedDomain::deleteOrganizationsPrefsAssociatedDomainByIdOrg()	deleteOrganizationsPrefsAssociatedDomainByIdOrg()	DELETE /organizations/{idOrg}/prefs/associatedDomain
OrganizationsPrefsBoardVisibilityRestrictOrg::updateOrganizationsPrefsBoardVisibilityRestrictOrgById()	updateOrganizationsPrefsBoardVisibilityRestrictOrgByIdOrg()	PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/org
OrganizationsPrefsBoardVisibilityRestrictPrivate::updateOrganizationsPrefsBoardVisibilityRestrictPrivateByIdOrg()	updateOrganizationsPrefsBoardVisibilityRestrictPrivateByIdOrg()	PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/private
OrganizationsPrefsBoardVisibilityRestrictPublic::updateOrganizationsPrefsBoardVisibilityRestrictPublicByIdOrg()	updateOrganizationsPrefsBoardVisibilityRestrictPublicByIdOrg()	PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/public
OrganizationsPrefsExternalMembersDisabled::updateOrganizationsPrefsExternalMembersDisabledByIdOrg()	updateOrganizationsPrefsExternalMembersDisabledByIdOrg()	PUT /organizations/{idOrg}/prefs/externalMembersDisabled
OrganizationsPrefsGoogleAppsVersion::updateOrganizationsPrefsGoogleAppsVersionByIdOrg()	updateOrganizationsPrefsGoogleAppsVersionByIdOrg()	PUT /organizations/{idOrg}/prefs/googleAppsVersion
OrganizationsPrefsOrgInviteRestrict::updateOrganizationsPrefsOrgInviteRestrictByIdOrg()	updateOrganizationsPrefsOrgInviteRestrictByIdOrg()	PUT /organizations/{idOrg}/prefs/orgInviteRestrict
OrganizationsPrefsOrgInviteRestrict::deleteOrganizationsPrefsOrgInviteRestrictByIdOrg()	deleteOrganizationsPrefsOrgInviteRestrictByIdOrg()	DELETE /organizations/{idOrg}/prefs/orgInviteRestrict
OrganizationsPrefsPermissionLevel::updateOrganizationsPrefsPermissionLevelByIdOrg()	updateOrganizationsPrefsPermissionLevelByIdOrg()	PUT /organizations/{idOrg}/prefs/permissionLevel
OrganizationsWebsite::updateOrganizationsWebsiteByIdOrg()	updateOrganizationsWebsiteByIdOrg()	PUT /organizations/{idOrg}/website
Search::get()	getSearch()	GET /search
SearchMembers::list()	getSearchMembers()	GET /search/members
Sessions::add()	addSessions()	POST /sessions
Sessions::updateSessionsById()	updateSessionsByIdSession()	PUT /sessions/{idSession}
SessionsSocket::get()	getSessionsSocket()	GET /sessions/socket
SessionsStatus::updateSessionsStatusById()	updateSessionsStatusByIdSession()	PUT /sessions/{idSession}/status
Tokens::getTokensBy()	getTokensByToken()	GET /tokens/{token}
Tokens::deleteTokensBy()	deleteTokensByToken()	DELETE /tokens/{token}
Tokens::getTokensByTokenByField()	getTokensByTokenByField()	GET /tokens/{token}/{field}
TokensMember::getTokensMemberBy()	getTokensMemberByToken()	GET /tokens/{token}/member
TokensMember::getTokensMemberByTokenByField()	getTokensMemberByTokenByField()	GET /tokens/{token}/member/{field}
TokensWebhooks::getTokensWebhooksBy()	getTokensWebhooksByToken()	GET /tokens/{token}/webhooks
TokensWebhooks::updateTokensWebhooksBy()	updateTokensWebhooksByToken()	PUT /tokens/{token}/webhooks
TokensWebhooks::addTokensWebhooksBy()	addTokensWebhooksByToken()	POST /tokens/{token}/webhooks
TokensWebhooks::getTokensWebhooksByTokenById()	getTokensWebhooksByTokenByIdWebhook()	GET /tokens/{token}/webhooks/{idWebhook}
TokensWebhooks::deleteTokensWebhooksByTokenById()	deleteTokensWebhooksByTokenByIdWebhook()	DELETE /tokens/{token}/webhooks/{idWebhook}
Types::getTypesById()	getTypesById()	GET /types/{id}
Webhooks::add()	addWebhooks()	POST /webhooks
Webhooks::update()	updateWebhooks()	PUT /webhooks/
Webhooks::getWebhooksById()	getWebhooksByIdWebhook()	GET /webhooks/{idWebhook}
Webhooks::updateWebhooksById()	updateWebhooksByIdWebhook()	PUT /webhooks/{idWebhook}
Webhooks::deleteWebhooksById()	deleteWebhooksByIdWebhook()	DELETE /webhooks/{idWebhook}
Webhooks::getWebhooksByIdWebhookByField()	getWebhooksByIdWebhookByField()	GET /webhooks/{idWebhook}/{field}
WebhooksActive::updateWebhooksActiveById()	updateWebhooksActiveByIdWebhook()	PUT /webhooks/{idWebhook}/active
WebhooksCallbackUrl::updateWebhooksCallbackUrlbyId()	updateWebhooksCallbackURLByIdWebhook()	PUT /webhooks/{idWebhook}/callbackURL
WebhooksDescription::updateWebhooksDescriptionById()	updateWebhooksDescriptionByIdWebhook()	PUT /webhooks/{idWebhook}/description
WebhooksIdModel::updateWebhooksIdModelById()	updateWebhooksIdModelByIdWebhook()	PUT /webhooks/{idWebhook}/idModel

Making a Request¶

There are two ways to make a request to the nominated API Handler and API Method:

If you built the client to be accessible globally, you can use the relevant API Handler Class directly:

use Tectalic\Trello\Handlers\Actions;
 
(new Actions())->getActionsById();

Alternatively, you can access all API Handlers from the client class using the Client class:

$client->actions()->getActionsById();

Retrieving the Response¶

Once you have made a request using one of the two methods outlined above, the next step is to access the response.

You can access the response in different ways. Please choose your preferred one.

Model Responses¶

Model responses are Data Transfer Object (DTO) style PHP classes, with public properties for each API property.

They offer a structured way of retrieving the response from an API request.

All Response Models are an instance of Tectalic\Trello\Models\AbstractModel or Tectalic\Trello\Models\AbstractModelCollection.

After performing the request, use the ->toModel() fluent method to the API Method:

use Tectalic\Trello\Handlers\Actions;
 
$model = (new Actions())->getActionsById()->toModel();

Each API Method’s toModel() call will return the appropriate Model class type for the API Method you have just called.

Associative Array Responses¶

After performing the request, use the ->toArray() fluent method to the API Method:

use Tectalic\Trello\Handlers\Actions;
 
$array = (new Actions())->getActionsById()->toArray();

In the resulting associative array, the array keys will match the names of the public properties in the relevant Model class.

PSR 7 Response Objects¶

If you need to access the raw response or inspect the HTTP headers, use the ->getResponse() fluent method to the API Method. It will return a Psr\Http\Message\ResponseInterface:

use Tectalic\Trello\Handlers\Actions;
 
$response = (new Actions())->getActionsById()->getResponse();

Errors¶

When performing requests with Tectalic Trello REST API Client, specific scenarios will cause a Tectalic\Trello\Exception\ClientException to be thrown. Please see below for details.

Invalid Usage of the Manager Class¶

A \LogicException will be thrown if the Manager::build() function is called multiple times, or if Manager::access() is called before calling Manager::build().

Unsuccessful HTTP Response Codes¶

The Tectalic Trello REST API Client depends on a PSR-18 compatible HTTP client, and that HTTP client should not throw an exception for unsuccessful HTTP response codes.

An unsuccessful response code is classified as one that is not in the range 200-299 (inclusive). Examples of unsuccessful response codes include:

• Informational responses (100-199)
• Redirection responses (300-399)
• Client error responses (400-499)
• Server error responses (500-599)

If an unsuccessful response code does occur:

• your HTTP Client will not throw an Exception.
• the API Handler’s toModel() method will throw a ClientException.
• the API Handler’s toArray() method will return the response body and not throw a ClientException.
• The API Handler’s getResponse() method will return the raw response and not throw a ClientException.

Below is an example of how you may wish to use a try/catch block when performing a request so that you can detect and handle unexpected errors.

use Tectalic\Trello\Authentication;
use Tectalic\Trello\Client;
use Tectalic\Trello\ClientException;
use Tectalic\Trello\Manager;
 
// Build a Tectalic Trello REST API Client globally.
$auth = new Authentication('key');
Manager::build($httpClient, $auth);
$handler = new Actions();
 
// Perform a request
try {
    $model = $handler->getActionsById()->toModel();
    // Do something with the response model...
} catch (ClientException $e) {
    // Error response received. Retrieve the HTTP response code and response body.
    $responseBody = $handler->toArray();
    $rawResponse  = $handler->getResponse()->getResponse();
    $responseCode = $handler->getResponse()->getStatusCode();
    // Handle the error...
}

HTTP Client Exceptions¶

If your HTTP client of choice throws an exception other than ClientException, the Tectalic Trello REST API Client Client and its API Handler classes will let these exceptions bubble up.

Consult your HTTP client’s documentation for more details on exception handling.

Tests¶

The Tectalic Trello REST API Client package includes several types of automated PHPUnit tests to verify the correct operation:

• Unit Tests
• Integration Tests

To run these tests, you will need to have installed the Tectalic Trello REST API Client package with its dev dependencies (i.e. not using the --no-dev flag when running composer).

Unit Tests¶

These PHPUnit tests are designed to:

• confirm that each API Method assembles a valid request that matches the Trello API OpenAPI specification.
• verify the behaviour of other parts of the package, such as the Client and Manager classes.

The unit tests can be run using the following command, which needs to be run from this package’s root directory.

composer test:unit

Unit tests do not perform any real requests against the Trello API.

Unit tests are located in the tests/Unit directory.

Integration Tests¶

Integration tests are located in the tests/Integration directory.

These PHPUnit tests are designed to confirm that each API Method parses a valid response, according to the Trello API OpenAPI specification. Out of the box the integration tests are designed to work with the Prism Mock Server.

Using Prism as the Target¶

Make sure Prism is installed. Please see the Prism documentation for details on how to install Prism.

Once Prism is installed, you can run prism and the integration tests side by side in separate terminal windows, or using the following command, which need to be run from this package’s root directory.

echo "> Starting Prism server"
prism mock tests/openapi.yaml >/dev/null 2>&1 &
PRISM_PID=$!
sleep 2
echo "  => Started"
composer test:integration
kill $PRISM_PID

Those commands will start the Prism mock server, then run the integration tests, and then stop the Prism mock server when the tests are completed.

In this case the integration tests do not perform any real requests against the Trello API.

Using a Different Target¶

By setting the TRELLO_CLIENT_TEST_BASE_URI environment variable, you can set a different API endpoint target for the integration tests.

For example, instead of using Prism, you can use a different mocking/staging/test server of your choice, or you can use the Trello API’s live endpoints.

Do not forget to set the appropriate credentials in the TRELLO_CLIENT_TEST_AUTH_KEY environment variable.

After your setup is complete simply run the following command.

composer test:integration

We do not recommend running integration tests against the live Trello API endpoints. This is because the tests will send example data to all endpoints, which can result in new data being created, or existing data being deleted.

Support¶

If you have any questions or feedback, you can submit a support request to the Tectalic developers by going to https://tectalic.com/support/trello.

License¶

This software is copyright (c) 2022 Tectalic.

For copyright and license information, please view https://tectalic.com/terms.