@managed-api/monday-v2024-04-sr-connect

v1.0.0

Published

3 months ago

Adaptavist Managed API for monday.com for ScriptRunner Connect environment

Downloads

0High
0Medium
0Low

adaptavist-horizon-dev

jsaks

eknoll

ScriptRunner Connect Managed API for monday.com

Managed API for monday.com is an API Client for monday.com by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

fetch
Board
- archiveBoard
- createBoard
- deleteBoard
- deleteSubscribersFromBoard
- duplicateBoard
- getBoards
- updateBoard
- View
  - getViews
- Group
- ItemsPage
  - getItemsPage
Column
File
Item
ItemsPage
- getNextItemsPage
- getItemsPageByColumnValues
Me
- getUserDetails
Notification
- createNotification
Team
User
Workspace
Folder
Update
Doc
- getDocs
- createDoc
- DocBlock
Tag
Version
- getVersion
- getVersions
Webhook

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { MondayApi } from '@managed-api/monday-sr-connect';

export default async function() {
    const api = new MondayApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

1.10.0

Pass update_id as ID in Update.likeUpdate.
Fix issue where column_value.column was incorrectly labelled as an array.
Add missing type options related to nested items_page.
Fix issue where nested queries were not always using the right types.

1.9.0

Update Group queries and mutations to return an items_page instead of items.
Fix getWebhooks response.
Add is_default_workspace field to workspace queries.

1.8.0

Add relative_to and position_relative_method to Item.createItem.
Add display_name field to version queries.
Update kind enum values in version queries.
Convert id arguments in all managed APIs to use ID type.
Add after_column_id arg to Column.createColumn.
Fix return type of item.id.

1.7.0

Update core package to 0.3.14.

1.6.0

Support version 2024-04 of Monday API.
Support for the following Team methods:
- addUsersToTeam that can be used as Team.addUsersToTeam or All.addUsersToTeam.
- removeUsersFromTeam that can be used as Team.removeUsersFromTeam or All.removeUsersFromTeam.
Added support for the following Workspace methods:
- updateWorkspace that can be used as Workspace.updateWorkspace or All.updateWorkspace
Changes to the following existing methods:
- Support voters field in VoteValue fragment.
- Support for group_color argument in createGroup.
- Support url field in boards and items.

1.5.0

Support for deleteTeamsFromBoard mutation.
Implement remaining column value fragments.
Fixing response objects for ItemsPage.getItemsPage.
Allow access to __typename field in returned GraphQL objects.

1.4.0

Support for complexity queries to monitor the cost of each operation you make
Using api version 2023-10 as default. Removing support for 2023-07
Support for StatusValue and TimelineValue fragments.

1.3.0

Added support for the following Folder methods:
- getFolders that can be used as Folder.getFolders or All.getFolders
- createFolder that can be used as Folder.createFolder or All.createFolder
- updateFolder that can be used as Folder.updateFolder or All.updateFolder
- deleteFolder that can be used as Folder.deleteFolder or All.deleteFolder
Converted all enum types to union types, for easier autocompletion suggestions
Added support for the following Webhook methods:
- getWebhooks that can be used as Webhook.getWebhooks or All.getWebhooks
- createWebhook that can be used as Webhook.createWebhook or All.createWebhook
- deleteWebhook that can be used as Webhook.deleteWebhook or All.deleteWebhook
Added column fields to column_values return type.
Added support for the following Version methods:
- getVersion that can be used as Version.getVersion or All.getVersion
- getVersions that can be used as Version.getVersions or All.getVersions
Added support for the following Tag methods:
- getTags that can be used as Tag.getTags or All.getTags
- getTags that can be used as Board.Tag.getTags
- createOrGetTag that can be used as Tag.createOrGetTag or All.createOrGetTag

1.2.0

Added support for the following Doc methods:
- getDocs that can be used as Doc.getDocs or All.getDocs
- createDoc that can be used as Doc.createDoc or All.createDoc
Added support for the following DocBlock methods:
- getDocBlocks that can be used as Doc.DocBlock.getDocBlocks or All.getDocBlocks
- createDocBlock that can be used as Doc.DocBlock.createDocBlock or All.createDocBlock
- updateDocBlock that can be used as Doc.DocBlock.updateDocBlock or All.updateDocBlock
- deleteDocBlock that can be used as Doc.DocBlock.deleteDocBlock or All.deleteDocBlock
Added support for all managed API methods for api 2023-10
Added support for the following ItemsPage methods:
- getItemsPage that can be used as Board.ItemsPage.getItemsPage or All.getItemsPage
- getNextItemsPage that can be used as Board.getNextItemsPage or All.getNextItemsPage
- getItemsPageByColumnValues that can be used as Board.getItemsPageByColumnValues or All.getItemsPageByColumnValues
Added support for the following Team methods:
- getTeams that can be used as Team.getTeams or All.getTeams
- addTeamsToBoard that can be used as Team.addTeamsToBoard or All.addTeamsToBoard
- addTeamsToWorkspace that can be used as Team.addTeamsToWorkspace or All.addTeamsToWorkspace
- deleteTeamsFromWorkspace that can be used as Team.deleteTeamsFromWorkspace or All.deleteTeamsFromWorkspace
Added support for the following Update methods:
- getUpdates that can be used as Update.getUpdates or All.getUpdates.
- createUpdate that can be used as Update.createUpdate or All.createUpdate.
- likeUpdate that can be used as Update.likeUpdate or All.likeUpdate.
- deleteUpdate that can be used as Update.deleteUpdate or All.deleteUpdate.
Added support for the following Item methods:
- moveItemToBoard that can be used as Item.moveItemToBoard or All.moveItemToBoard.
Added support for the following Group methods:
- updateGroup that can be used as Board.Group.updateGroup or All.updateGroup.
- archiveGroup that can be used as Board.Group.archiveGroup or All.archiveGroup.
- duplicateGroup that can be used as Board.Group.duplicateGroup or All.duplicateGroup.
- deleteGroup that can be used as Board.Group.deleteGroup or All.deleteGroup.
Added support for the following Group methods:
- createGroup that can be used as Board.Group.createGroup or All.createGroup.
Added support for the following Workspace methods:
- createWorkspace that can be used as Workspace.createWorkspace or All.createWorkspace.
- deleteWorkspace that can be used as Workspace.deleteWorkspace or All.deleteWorkspace.
- getWorkspaces that can be used as Workspace.getWorkspaces or All.getWorkspaces.
Added support for the following Group methods:
- getGroups
Added support for the following Notification methods:
- createNotification that can be used as Notification.createNotification or All.createNotification.

0.9.0

Changed type from number[] to string[] of ids field in groups arguments for Board fields.

0.7.0

Added support for the following Column methods:
- changeColumnMetadata that can be used as Column.changeColumnMetadata or All.changeColumnMetadata.
- changeColumnTitle that can be used as Column.changeColumnTitle or All.changeColumnTitle.
- changeColumnValue that can be used as Column.changeColumnValue or All.changeColumnValue.
- changeMultipleColumnValues that can be used as Column.changeMultipleColumnValues or All.changeMultipleColumnValues.
- changeSimpleColumnValue that can be used as Column.changeSimpleColumnValue or All.changeSimpleColumnValue.
- createColumn that can be used as Column.createColumn or All.createColumn.
- deleteColumn that can be used as Column.deleteColumn or All.deleteColumn.

0.5.0

Added support for the following Board methods:
- archiveBoard that can be used as Board.archiveBoard or All.archiveBoard.
- createBoard that can be used as Board.createBoard or All.createBoard.
- deleteBoard that can be used as Board.deleteBoard or All.deleteBoard.
- deleteSubscribersFromBoard that can be used as Board.deleteSubscribersFromBoard or All.deleteSubscribersFromBoard.
- duplicateBoard that can be used as Board.duplicateBoard or All.duplicateBoard.
- getBoards that can be used as Board.getBoards or All.getBoards.
- updateBoard that can be used as Board.updateBoard or All.updateBoard.
Added support for the following Board.View methods:
- getViews that can be used as Board.View.getViews or All.getBoardViews.
Added support for the following File methods:
- addFileToColumn that can be used as File.addFileToColumn or All.addFileToColumn.
- addFileToUpdate that can be used as File.addFileToUpdate or All.addFileToUpdate.
- getAssets that can be used as File.getAssets or All.getAssets.
Added support for the following Item methods:
- archiveItem that can be used as Item.archiveItem or All.archiveItem.
- clearUpdates that can be used as Item.clearUpdates or All.clearItemUpdates.
- createItem that can be used as Item.createItem or All.createItem.
- deleteItem that can be used as Item.deleteItem or All.deleteItem.
- duplicateItem that can be used as Item.duplicateItem or All.duplicateItem.
- getItems that can be used as Item.getItems or All.getItems.
- moveItemToGroup that can be used as Item.moveItemToGroup or All.moveItemToGroup.
Added support for the following Item.Subitem methods:
- createSubitem that can be used as Item.Subitem.createSubitem or All.createSubitem.
- getSubitems that can be used as Item.Subitem.getSubitems or All.getSubitems.
Added support for the following Me methods:
- getUserDetails that can be used as Me.getUserDetails or All.getUserDetails.
Added support for the following User methods:
- addUsersToBoard that can be used as User.addUsersToBoard or All.addUsersToBoard.
- addUsersToWorkspace that can be used as User.addUsersToWorkspace or All.addUsersToWorkspace.
- deleteUsersFromWorkspace that can be used as User.deleteUsersFromWorkspace or All.deleteUsersFromWorkspace.
- getUsers that can be used as User.getUsers or All.getUsers.