@managed-api/trello-core

v2.0.0

Published

4 months ago

Adaptavist Managed API for Trello

Downloads

0High
0Medium
0Low

adaptavist-horizon-dev

jsaks

eknoll

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

ScriptRunner Connect

Supported API calls

fetch
Board
Card
CustomField
- createCustomField
- getCustomField
Member
- getMember
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 or All.getCustomFieldItemsForCard.

1.6.0

Corrected idLabels field type in request of the following method:
- updateCard that can be used as Card.updateCard or All.updateCard.

1.5.0

Added support for the following Member method:
- getMember that can be used as Member.getMember or All.getMember.
Added support for the following Board method:
- getLabels that can be used as Board.getLabels or All.getLabelsForBoard.
Added support for the following Board method:
- getLists that can be used as Board.getLists or All.getListsForBoard.
Corrected labels field type in response of the following method:
- getCard that can be used as Card.getCard or All.getCard.
Corrected idMembers field type in request of the following method:
- updateCard that can be used as Card.updateCard or All.updateCard.

1.4.0

Added support for the following CustomField method:
- createCustomField that can be used as CustomField.createCustomField or All.createCustomField.
- getCustomField that can be used as CustomField.getCustomField or All.getCustomField.

1.2.0

Added support for the following Webhook method:
- createWebhook that can be used as Webhook.createWebhook or All.createWebhook.
- getWebhook that can be used as Webhook.getWebhook or All.getWebhook.
- updateWebhook that can be used as Webhook.updateWebhook or All.updateWebhook.
- deleteWebhook that can be used as Webhook.deleteWebhook or All.deleteWebhook.
- getField that can be used as Webhook.getField or All.getWebhookField.

0.4.0

Added support for the following Board method:
- createBoard that can be used as Board.createBoard or All.createBoard.
- deleteBoard that can be used as Board.deleteBoard or All.deleteBoard.
- getBoard that can be used as Board.getBoard or All.getBoard.
- getMemberships that can be used as Board.getMemberships or All.getMembershipsForBoard.
- updateBoard that can be used as Board.updateBoard or All.updateBoard.
Added support for the following Board.Member method:
- addMember that can be used as Board.Member.addMember or All.addMemberToBoard.
- getMembers that can be used as Board.Member.getMembers or All.getMembersForBoard.
- inviteMemberByEmail that can be used as Board.Member.inviteMemberByEmail or All.inviteMemberToBoardByEmail.
- removeMember that can be used as Board.Member.removeMember or All.removeMemberFromBoard.
Added support for the following Card method:
- addLabel that can be used as Card.addLabel or All.addLabelForCard.
- addMember that can be used as Card.addLabel or All.addLabelForCard.
- addMemberVote that can be used as Card.addMemberVote or All.addMemberVoteForCard.
- createCard that can be used as Card.createCard or All.createCard.
- createLabel that can be used as Card.createLabel or All.createLabelForCard.
- deleteCard that can be used as Card.deleteCard or All.deleteCard.
- getActions that can be used as Card.getActions or All.getActionsForCard.
- getBoardForCard that can be used as Card.getBoardForCard or All.getBoardForCard.
- getCard that can be used as Card.getCard or All.getCardForAction.
- getField that can be used as Card.getField or All.getFieldForBoard.
- getList that can be used as Card.getList or All.getList.
- getMembers that can be used as Card.getMembers or All.getMembersForCard.
- getMembersWhoVoted that can be used as Card.getMembersWhoVoted or All.getMembersWhoVotedForCard.
- markNotificationsAsRead that can be used as Card.markNotificationsAsRead or All.markNotificationsAsReadForCard.
- removeLabel that can be used as Card.removeLabel or All.removeLabelForCard.
- removeMember that can be used as Card.removeMember or All.removeMemberFromCard.
- removeMemberVote that can be used as Card.removeMemberVote or All.removeMemberVote.
- updateCard that can be used as Card.updateCard or All.updateCard.
Added support for the following Card.Attachment method:
- createAttachment that can be used as Card.Attachment.createAttachment or All.createAttachmentForCard.
- deleteAttachment that can be used as Card.Attachment.deleteAttachment or All.deleteAttachmentForCard.
- getAttachment that can be used as Card.Attachment.getAttachment or All.getAttachmentForCard.
- getAttachments that can be used as Card.Attachment.getAttachments or All.getAttachmentsForCard.
Added support for the following Card.Checklist method:
- createChecklist that can be used as Card.Checklist.createChecklist or All.createChecklistForCard.
- deleteCheckItem that can be used as Card.Checklist.deleteCheckItem or All.deleteCheckItemForCard.
- deleteChecklist that can be used as Card.Checklist.deleteChecklist or All.deleteChecklist.
- getCheckItem that can be used as Card.Checklist.getCheckItem or All.getCheckItemForCard.
- getCheckItems that can be used as Card.Checklist.getCheckItem or All.getCheckItemForCard.
- getChecklists that can be used as Card.Checklist.getChecklists or All.getChecklistsForCard.
- updateCheckItem that can be used as Card.Checklist.updateCheckItem or All.updateCheckItemForCard.
- updateCheckItemOnChecklist that can be used as Card.Checklist.updateCheckItemOnChecklist or All.updateCheckItemOnChecklist.
Added support for the following Card.Comment method:
- addComment that can be used as Card.Comment.addComment or All.addCommentForCard.
- deleteComment that can be used as Card.Comment.deleteComment or All.deleteCommentForCard.
- updateComment that can be used as Card.Comment.updateComment or All.updateCommentForCard.
Added support for the following Card.CustomField method:
- getCustomFieldItems that can be used as Card.CustomField.getCustomFieldItems or All.getCustomFieldItemsForCard.
- updateCustomFieldItem that can be used as Card.CustomField.updateCustomFieldItem or All.updateCustomFieldItemForCard.
Added support for the following Card.Sticker method:
- addSticker that can be used as Card.Sticker.addSticker or All.addStickerForCard.
- deleteSticker that can be used as Card.Sticker.deleteSticker or All.deleteStickerForCard.
- getSticker that can be used as Card.Sticker.getSticker or All.getStickerForCard.
- getStickers that can be used as Card.Sticker.getStickers or All.getStickersForCard.
- updateSticker that can be used as Card.Sticker.updateSticker or All.updateStickerForCard.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Managed API for Trello

Platform specific ports

Supported API calls

Porting to other runtimes

Contact

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:

1.6.0

Corrected idLabels field type in request of the following method:

1.5.0

Added support for the following Member method:

Added support for the following Board method:

Added support for the following Board method:

Corrected labels field type in response of the following method:

Corrected idMembers field type in request of the following method:

1.4.0

Added support for the following CustomField method:

1.2.0

Added support for the following Webhook method:

0.4.0

Added support for the following Board method:

Added support for the following Board.Member method:

Added support for the following Card method:

Added support for the following Card.Attachment method:

Added support for the following Card.Checklist method:

Added support for the following Card.Comment method:

Added support for the following Card.CustomField method:

Added support for the following Card.Sticker method:

Added `value.text` field in response of the following method:

Corrected `idLabels` field type in request of the following method:

Corrected `labels` field type in response of the following method:

Corrected `idMembers` field type in request of the following method: