@managed-api/monday-core
v2.28.0
Published
Adaptavist Managed API for monday.com
Downloads
75
Keywords
Readme
Managed API for monday.com
Managed API for monday.com is an API Client for monday.com 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
- Column
- File
- Item
- ItemsPage
- Me
- Notification
- Team
- User
- Workspace
- Folder
- Update
- Doc
- Tag
- Version
- 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 yo 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 { MondayApiCore } from "@managed-api/monday-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";
export class MondayApi extends MondayApiCore {
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 yo 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.28.0
- Updated development setup instructions
2.27.0
- Pass
update_id
asID
inUpdate.likeUpdate
.
2.26.0
- Add build script for local development and testing.
2.25.0
- Fix issue where
column_value.column
was incorrectly labelled as an array.
2.24.0
- Add missing type options related to nested
items_page
. - Pass API version down to nested types.
2.23.0
- Update
Group
queries and mutations to return anitems_page
instead ofitems
.
2.22.0
- Fix
getWebhooks
response.
2.21.0
- Add
is_default_workspace
field toworkspace
queries.
2.20.0
- Add
relative_to
andposition_relative_method
toItem.createItem
.
2.19.0
- Add
display_name
field toversion
queries. - Update
kind
enum values inversion
queries.
2.18.0
- Convert id arguments in all managed APIs to use
ID
type. - Add missing
after_column_id
arg toColumn.createColumn
. - Fix return type of
item.id
.
2.17.0
- Update common cores package to version
0.3.14
.
2.16.0
Support for the following Team methods:
- addUsersToTeam that can be used as
Team.addUsersToTeam
orAll.addUsersToTeam
. - removeUsersFromTeam that can be used as
Team.removeUsersFromTeam
orAll.removeUsersFromTeam
.
- addUsersToTeam that can be used as
2.15.0
Added support for the following Workspace methods:
- updateWorkspace that can be used as
Workspace.updateWorkspace
orAll.updateWorkspace
- updateWorkspace that can be used as
2.14.0
- Support
voters
field in VoteValue fragment.
2.13.0
- Support for
group_color
argument in createGroup.
2.12.0
- Support version 2024-04 of Monday API.
- Support
url
field in boards and items.
2.11.0
Added support for the following Team methods:
- deleteTeamsFromBoard that can be used as
Team.deleteTeamsFromBoard
orAll.deleteTeamsFromBoard
.
- deleteTeamsFromBoard that can be used as
2.10.0
- Implement remaining column value fragments.
2.9.0
- Fixing response objects for ItemsPage.getItemsPage.
2.8.0
- Allow access to
__typename
field in returned GraphQL objects.
2.7.0
- Fix issue with
items_page
managed API preventing Monday from acceptingquery_params
arguments.
2.6.0
- Support for StatusValue and TimelineValue fragments.
2.5.0
- Support for complexity queries to monitor the cost of each operation you make
2.4.0
- Using api version 2023-10 as default. Removing support for 2023-07
2.2.0
Added support for the following Folder methods:
- getFolders that can be used as
Folder.getFolders
orAll.getFolders
- createFolder that can be used as
Folder.createFolder
orAll.createFolder
- updateFolder that can be used as
Folder.updateFolder
orAll.updateFolder
- deleteFolder that can be used as
Folder.deleteFolder
orAll.deleteFolder
- getFolders that can be used as
2.0.0
- Converted all enum types to union types, for easier autocompletion suggestions
1.18.0
Added support for the following Webhook methods:
- getWebhooks that can be used as
Webhook.getWebhooks
orAll.getWebhooks
- createWebhook that can be used as
Webhook.createWebhook
orAll.createWebhook
- deleteWebhook that can be used as
Webhook.deleteWebhook
orAll.deleteWebhook
- getWebhooks that can be used as
1.17.0
Added column fields to column_values return type.
1.16.0
Added support for the following Version methods:
- getVersion that can be used as
Version.getVersion
orAll.getVersion
- getVersions that can be used as
Version.getVersions
orAll.getVersions
- getVersion that can be used as
1.15.0
Added support for the following Tag methods:
- getTags that can be used as
Tag.getTags
orAll.getTags
- getTags that can be used as
Board.Tag.getTags
- createOrGetTag that can be used as
Tag.createOrGetTag
orAll.createOrGetTag
- getTags that can be used as
1.14.0
Added support for the following Doc methods:
Added support for the following DocBlock methods:
- getDocBlocks that can be used as
Doc.DocBlock.getDocBlocks
orAll.getDocBlocks
- createDocBlock that can be used as
Doc.DocBlock.createDocBlock
orAll.createDocBlock
- updateDocBlock that can be used as
Doc.DocBlock.updateDocBlock
orAll.updateDocBlock
- deleteDocBlock that can be used as
Doc.DocBlock.deleteDocBlock
orAll.deleteDocBlock
- getDocBlocks that can be used as
1.13.0
Added support for all managed API methods for api 2023-10
1.11.0
Added support for the following ItemsPage methods:
- getItemsPage that can be used as
Board.ItemsPage.getItemsPage
orAll.getItemsPage
- getNextItemsPage that can be used as
Board.getNextItemsPage
orAll.getNextItemsPage
- getItemsPageByColumnValues that can be used as
Board.getItemsPageByColumnValues
orAll.getItemsPageByColumnValues
- getItemsPage that can be used as
1.9.0
Added support for the following Team methods:
- getTeams that can be used as
Team.getTeams
orAll.getTeams
- addTeamsToBoard that can be used as
Team.addTeamsToBoard
orAll.addTeamsToBoard
- addTeamsToWorkspace that can be used as
Team.addTeamsToWorkspace
orAll.addTeamsToWorkspace
- deleteTeamsFromWorkspace that can be used as
Team.deleteTeamsFromWorkspace
orAll.deleteTeamsFromWorkspace
- getTeams that can be used as
1.8.0
Added support for the following Update methods:
- getUpdates that can be used as
Update.getUpdates
orAll.getUpdates
. - createUpdate that can be used as
Update.createUpdate
orAll.createUpdate
. - likeUpdate that can be used as
Update.likeUpdate
orAll.likeUpdate
. - deleteUpdate that can be used as
Update.deleteUpdate
orAll.deleteUpdate
.
- getUpdates that can be used as
1.7.0
Added support for the following Item methods:
- moveItemToBoard that can be used as
Item.moveItemToBoard
orAll.moveItemToBoard
.
- moveItemToBoard that can be used as
1.6.0
Added support for the following Group methods:
- updateGroup that can be used as
Board.Group.updateGroup
orAll.updateGroup
. - archiveGroup that can be used as
Board.Group.archiveGroup
orAll.archiveGroup
. - duplicateGroup that can be used as
Board.Group.duplicateGroup
orAll.duplicateGroup
. - deleteGroup that can be used as
Board.Group.deleteGroup
orAll.deleteGroup
.
- updateGroup that can be used as
1.5.0
Added support for the following Group methods:
- createGroup that can be used as
Board.Group.createGroup
orAll.createGroup
.
- createGroup that can be used as
1.4.0
Added support for the following Workspace methods:
- createWorkspace that can be used as
Workspace.createWorkspace
orAll.createWorkspace
. - deleteWorkspace that can be used as
Workspace.deleteWorkspace
orAll.deleteWorkspace
. - getWorkspaces that can be used as
Workspace.getWorkspaces
orAll.getWorkspaces
.
- createWorkspace that can be used as
1.3.0
Added support for the following Group methods:
1.2.0
Added support for the following Notification methods:
- createNotification that can be used as
Notification.createNotification
orAll.createNotification
.
- createNotification that can be used as
0.10.0
- Changed type from
number[]
tostring[]
ofids
field ingroups
arguments for Board fields.
0.8.0
Added support for the following Column methods:
- changeColumnMetadata that can be used as
Column.changeColumnMetadata
orAll.changeColumnMetadata
. - changeColumnTitle that can be used as
Column.changeColumnTitle
orAll.changeColumnTitle
. - changeColumnValue that can be used as
Column.changeColumnValue
orAll.changeColumnValue
. - changeMultipleColumnValues that can be used as
Column.changeMultipleColumnValues
orAll.changeMultipleColumnValues
. - changeSimpleColumnValue that can be used as
Column.changeSimpleColumnValue
orAll.changeSimpleColumnValue
. - createColumn that can be used as
Column.createColumn
orAll.createColumn
. - deleteColumn that can be used as
Column.deleteColumn
orAll.deleteColumn
.
- changeColumnMetadata that can be used as
0.5.0
Added support for the following Board methods:
- archiveBoard that can be used as
Board.archiveBoard
orAll.archiveBoard
. - createBoard that can be used as
Board.createBoard
orAll.createBoard
. - deleteBoard that can be used as
Board.deleteBoard
orAll.deleteBoard
. - deleteSubscribersFromBoard that can be used as
Board.deleteSubscribersFromBoard
orAll.deleteSubscribersFromBoard
. - duplicateBoard that can be used as
Board.duplicateBoard
orAll.duplicateBoard
. - getBoards that can be used as
Board.getBoards
orAll.getBoards
. - updateBoard that can be used as
Board.updateBoard
orAll.updateBoard
.
- archiveBoard that can be used as
Added support for the following Board.View methods:
- getViews that can be used as
Board.View.getViews
orAll.getBoardViews
.
- getViews that can be used as
Added support for the following File methods:
- addFileToColumn that can be used as
File.addFileToColumn
orAll.addFileToColumn
. - addFileToUpdate that can be used as
File.addFileToUpdate
orAll.addFileToUpdate
. - getAssets that can be used as
File.getAssets
orAll.getAssets
.
- addFileToColumn that can be used as
Added support for the following Item methods:
- archiveItem that can be used as
Item.archiveItem
orAll.archiveItem
. - clearUpdates that can be used as
Item.clearUpdates
orAll.clearItemUpdates
. - createItem that can be used as
Item.createItem
orAll.createItem
. - deleteItem that can be used as
Item.deleteItem
orAll.deleteItem
. - duplicateItem that can be used as
Item.duplicateItem
orAll.duplicateItem
. - getItems that can be used as
Item.getItems
orAll.getItems
. - moveItemToGroup that can be used as
Item.moveItemToGroup
orAll.moveItemToGroup
.
- archiveItem that can be used as
Added support for the following Item.Subitem methods:
- createSubitem that can be used as
Item.Subitem.createSubitem
orAll.createSubitem
. - getSubitems that can be used as
Item.Subitem.getSubitems
orAll.getSubitems
.
- createSubitem that can be used as
Added support for the following Me methods:
- getUserDetails that can be used as
Me.getUserDetails
orAll.getUserDetails
.
- getUserDetails that can be used as
Added support for the following User methods:
- addUsersToBoard that can be used as
User.addUsersToBoard
orAll.addUsersToBoard
. - addUsersToWorkspace that can be used as
User.addUsersToWorkspace
orAll.addUsersToWorkspace
. - deleteUsersFromWorkspace that can be used as
User.deleteUsersFromWorkspace
orAll.deleteUsersFromWorkspace
. - getUsers that can be used as
User.getUsers
orAll.getUsers
.
- addUsersToBoard that can be used as
Copyright Adaptavist 2023 (c) All rights reserved