@managed-api/trello-core
v2.0.0
Published
Adaptavist Managed API for Trello
Downloads
21
Keywords
Readme
Managed API for Trello
Managed API for Trello is an API Client for Trello by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.
This is a runtime agnostic version of the Managed API (with core
suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.
Platform specific ports
Supported API calls
- fetch
- Board
- Card
- CustomField
- Member
- Webhook
Porting to other runtimes
While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.
You can do so by extending the *Core
Managed API class where you'll be asked to provide implementation for getPlatformImplementation
function. In this implementation you have to specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:
{
buffer: {
encode(input: string): ArrayBuffer;
decode(input: ArrayBuffer): string;
},
performHttpCall(request: Request): Promise<Response>
}
Here is an example how to create a Node port of the Managed API:
import { TrelloApiCore } from "@managed-api/trello-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";
export class TrelloApi extends TrelloApiCore {
constructor(private baseUrl: string, private authToken: string) {
super();
}
protected getPlatformImplementation(): PlatformImplementation {
return {
buffer: {
encode: (input) => Buffer.from(input, 'utf-8'),
decode: (input) => Buffer.from(input).toString('utf-8')
},
performHttpCall: (request) => this.performHttpCall(request)
};
}
private async performHttpCall(request: Request): Promise<Response> {
const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
request.headers.set('Authorization', `Basic ${this.authToken}`); // Substitute auth token
const response = await fetch(requestUrl, {
method: request.method,
headers: request.headers as any,
body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
});
const apiHeaders = new Headers();
response.headers.forEach((value, key) => apiHeaders.append(key, value));
const body = await response.arrayBuffer();
return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
}
}
Please note that the authentication handling details may not be accurate and serve as an example. If you wish to use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.
Contact
At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to [email protected] for ideas, suggestions and improvements.
Changelog
2.0.0
Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.
1.7.0
Added
value.text
field in response of the following method:- getCustomFieldItems that can be used as
Card.CustomField.getCustomFieldItems
orAll.getCustomFieldItemsForCard
.
- getCustomFieldItems that can be used as
1.6.0
Corrected
idLabels
field type in request of the following method:- updateCard that can be used as
Card.updateCard
orAll.updateCard
.
- updateCard that can be used as
1.5.0
Added support for the following Member method:
- getMember that can be used as
Member.getMember
orAll.getMember
.
- getMember that can be used as
Added support for the following Board method:
- getLabels that can be used as
Board.getLabels
orAll.getLabelsForBoard
.
- getLabels that can be used as
Added support for the following Board method:
- getLists that can be used as
Board.getLists
orAll.getListsForBoard
.
- getLists that can be used as
Corrected
labels
field type in response of the following method:- getCard that can be used as
Card.getCard
orAll.getCard
.
- getCard that can be used as
Corrected
idMembers
field type in request of the following method:- updateCard that can be used as
Card.updateCard
orAll.updateCard
.
- updateCard that can be used as
1.4.0
Added support for the following CustomField method:
- createCustomField that can be used as
CustomField.createCustomField
orAll.createCustomField
. - getCustomField that can be used as
CustomField.getCustomField
orAll.getCustomField
.
- createCustomField that can be used as
1.2.0
Added support for the following Webhook method:
- createWebhook that can be used as
Webhook.createWebhook
orAll.createWebhook
. - getWebhook that can be used as
Webhook.getWebhook
orAll.getWebhook
. - updateWebhook that can be used as
Webhook.updateWebhook
orAll.updateWebhook
. - deleteWebhook that can be used as
Webhook.deleteWebhook
orAll.deleteWebhook
. - getField that can be used as
Webhook.getField
orAll.getWebhookField
.
- createWebhook that can be used as
0.4.0
Added support for the following Board method:
- createBoard that can be used as
Board.createBoard
orAll.createBoard
. - deleteBoard that can be used as
Board.deleteBoard
orAll.deleteBoard
. - getBoard that can be used as
Board.getBoard
orAll.getBoard
. - getMemberships that can be used as
Board.getMemberships
orAll.getMembershipsForBoard
. - updateBoard that can be used as
Board.updateBoard
orAll.updateBoard
.
- createBoard that can be used as
Added support for the following Board.Member method:
- addMember that can be used as
Board.Member.addMember
orAll.addMemberToBoard
. - getMembers that can be used as
Board.Member.getMembers
orAll.getMembersForBoard
. - inviteMemberByEmail that can be used as
Board.Member.inviteMemberByEmail
orAll.inviteMemberToBoardByEmail
. - removeMember that can be used as
Board.Member.removeMember
orAll.removeMemberFromBoard
.
- addMember that can be used as
Added support for the following Card method:
- addLabel that can be used as
Card.addLabel
orAll.addLabelForCard
. - addMember that can be used as
Card.addLabel
orAll.addLabelForCard
. - addMemberVote that can be used as
Card.addMemberVote
orAll.addMemberVoteForCard
. - createCard that can be used as
Card.createCard
orAll.createCard
. - createLabel that can be used as
Card.createLabel
orAll.createLabelForCard
. - deleteCard that can be used as
Card.deleteCard
orAll.deleteCard
. - getActions that can be used as
Card.getActions
orAll.getActionsForCard
. - getBoardForCard that can be used as
Card.getBoardForCard
orAll.getBoardForCard
. - getCard that can be used as
Card.getCard
orAll.getCardForAction
. - getField that can be used as
Card.getField
orAll.getFieldForBoard
. - getList that can be used as
Card.getList
orAll.getList
. - getMembers that can be used as
Card.getMembers
orAll.getMembersForCard
. - getMembersWhoVoted that can be used as
Card.getMembersWhoVoted
orAll.getMembersWhoVotedForCard
. - markNotificationsAsRead that can be used as
Card.markNotificationsAsRead
orAll.markNotificationsAsReadForCard
. - removeLabel that can be used as
Card.removeLabel
orAll.removeLabelForCard
. - removeMember that can be used as
Card.removeMember
orAll.removeMemberFromCard
. - removeMemberVote that can be used as
Card.removeMemberVote
orAll.removeMemberVote
. - updateCard that can be used as
Card.updateCard
orAll.updateCard
.
- addLabel that can be used as
Added support for the following Card.Attachment method:
- createAttachment that can be used as
Card.Attachment.createAttachment
orAll.createAttachmentForCard
. - deleteAttachment that can be used as
Card.Attachment.deleteAttachment
orAll.deleteAttachmentForCard
. - getAttachment that can be used as
Card.Attachment.getAttachment
orAll.getAttachmentForCard
. - getAttachments that can be used as
Card.Attachment.getAttachments
orAll.getAttachmentsForCard
.
- createAttachment that can be used as
Added support for the following Card.Checklist method:
- createChecklist that can be used as
Card.Checklist.createChecklist
orAll.createChecklistForCard
. - deleteCheckItem that can be used as
Card.Checklist.deleteCheckItem
orAll.deleteCheckItemForCard
. - deleteChecklist that can be used as
Card.Checklist.deleteChecklist
orAll.deleteChecklist
. - getCheckItem that can be used as
Card.Checklist.getCheckItem
orAll.getCheckItemForCard
. - getCheckItems that can be used as
Card.Checklist.getCheckItem
orAll.getCheckItemForCard
. - getChecklists that can be used as
Card.Checklist.getChecklists
orAll.getChecklistsForCard
. - updateCheckItem that can be used as
Card.Checklist.updateCheckItem
orAll.updateCheckItemForCard
. - updateCheckItemOnChecklist that can be used as
Card.Checklist.updateCheckItemOnChecklist
orAll.updateCheckItemOnChecklist
.
- createChecklist that can be used as
Added support for the following Card.Comment method:
- addComment that can be used as
Card.Comment.addComment
orAll.addCommentForCard
. - deleteComment that can be used as
Card.Comment.deleteComment
orAll.deleteCommentForCard
. - updateComment that can be used as
Card.Comment.updateComment
orAll.updateCommentForCard
.
- addComment that can be used as
Added support for the following Card.CustomField method:
- getCustomFieldItems that can be used as
Card.CustomField.getCustomFieldItems
orAll.getCustomFieldItemsForCard
. - updateCustomFieldItem that can be used as
Card.CustomField.updateCustomFieldItem
orAll.updateCustomFieldItemForCard
.
- getCustomFieldItems that can be used as
Added support for the following Card.Sticker method:
- addSticker that can be used as
Card.Sticker.addSticker
orAll.addStickerForCard
. - deleteSticker that can be used as
Card.Sticker.deleteSticker
orAll.deleteStickerForCard
. - getSticker that can be used as
Card.Sticker.getSticker
orAll.getStickerForCard
. - getStickers that can be used as
Card.Sticker.getStickers
orAll.getStickersForCard
. - updateSticker that can be used as
Card.Sticker.updateSticker
orAll.updateStickerForCard
.
- addSticker that can be used as
Copyright Adaptavist 2024 (c) All rights reserved