2.3.0 • Published 7 months ago

@managed-api/confluence-cloud-v2-sr-connect v2.3.0

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
7 months ago

ScriptRunner Connect Managed API for Confluence Cloud

Managed API for Confluence Cloud is an API Client for Confluence Cloud 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

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 { ConfluenceCloudApi } from '@managed-api/confluence-cloud-v2-sr-connect';

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

Contact

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

Changelog

2.3.0

  • Removed non-empty body from HEAD requests.

2.2.0

  • The following methods are deprecated:

  • Added support for the following V1.Content.Body methods:

  • Added support for the following Children methods:

  • Added support for the following Descendant methods:

  • Added support for the following Folder methods:

    • Create folder that can be used as Folder.createFolder or All.createFolder.
    • Get folder by id that can be used as Folder.getFolderById or All.getFolderById.
    • Delete folder that can be used as Folder.deleteFolder or All.deleteFolder.

  • Added support for the following Content.Property.Folder methods:

  • Added support for the following Database methods:

    • Create database that can be used as Database.createDatabase or All.createDatabase.
    • Get database by id that can be used as Database.getDatabaseById or All.getDatabaseById.
    • Delete database that can be used as Database.deleteDatabase or All.deleteDatabase.

  • Added support for the following SmartLink methods:

  • Added support for the following Ancestor methods:

  • Changes the following methods:

    • V1.LongRunningTask.getLongRunningTasks - Key parameter was added.
    • V1.Template.getBlueprintTemplates - body.storage option was added to expand.
    • V1.Template.getContentTemplates - body.storage option was added to expand.
    • V1.User.getUsersWithIds - isExternalCollaborator option was added to expand, limit was removed.
    • V1.User.getUsersWithIds - isExternalCollaborator option was added to expand, limit was removed.
    • Attachment.getAttachmentById - include-collaborators parameter was added.
    • BlogPost.getBlogPostById - status, include-webresources and include-collaborators parameters were added.
    • CustomContent.getCustomContentById - include-collaborators parameter was added.
    • Page.getPageById - status, include-webresources, include-collaborators and include-direct-children parameters were added.
    • Whiteboard.getWhiteboardById - include-collaborators, include-direct-children, include-operations and include-properties parameters were added.
    • Space.getSpaces - collaboration and knowledge_base was added to type.
    • Comment.Footer.Page.getComments - status parameter was added.
    • Comment.Inline.Page.getComments - status and resolution-status parameter were added.
    • Comment.Footer.BlogPost.getComments - status parameter was added.
    • Comment.Inline.BlogPost.getComments - status and resolution-status parameter were added.
    • BlogPost.createBlogPost - createdAt parameter was added.
    • BlogPost.updateBlogPost - createdAt parameter was added.
    • CustomContent.createCustomContent - draft option was added to status.
    • Whiteboard.createWhiteboard - templateKey and locale parameters were added.

2.1.0

  • Updated OpenApi Specification.

    • Added new fields include-labels, include-properties, include-operations, include-versions and include-version to Attachment.getAttachmentById.
    • Added new field purge toAttachment.deleteAttachment.
    • Added new field purge toCustomContent.deleteCustomContent.
    • Added new field version to Comment.Attachment.getComments.
    • Added new fields include-labels, include-properties, include-operations, include-versions, include-version and include-favorited-by-current-user-status to CustomContent.getCustomContentById.
    • Added new fields draft and purge to BlogPost.deleteBlogPost.
    • Added new fields draft and purge to Page.deletePage.
    • Added new field root-level to Page.createPage.
    • Added new fields include-labels, include-properties, include-operations, include-versions, include-version, include-likes, and include-favorited-by-current-user-status to Page.getPageById.
    • Added new fields favorited-by and not-favorited-by to Space.getSpaces.
    • Added new fields include-labels, include-properties, include-operationsand include-permissions to Space.getSpaceById.
    • Added new fields include-properties, include-operations, include-versions, include-version and include-likes to Comment.Footer.getCommentById.
    • Added new fields include-properties, include-operations, include-versions, include-version and include-likes to Comment.Inline.getCommentById.
    • Added new field body-format to Task.updateTask.
    • Removed deleted from status in BlogPost.updateBlogPost.
    • Added new field ownerId to Page.updatePage.
    • Attachment definition got changed to AttachmentSingle.
    • New properties in PageSingle definition.
    • New properties in PageBulk definition.

  • Added support for the following Comment.CustomContent method:

  • Added support for the following Whiteboard methods:

    • Create whiteboard that can be used as Whiteboard.createWhiteboard or All.getWhiteboard.
    • Get whiteboard by id that can be used as Whiteboard.getWhiteboardById or All.getWhiteboardById.
    • Delete whiteboard that can be used as Whiteboard.deleteWhiteboard or All.deleteWhiteboard.

  • Added support for the following Content.Property.Whiteboard methods:

  • Added support for the following Ancestor method:

  • Fixed following methods:

    • Get footer comments that can be used as Comment.Footer.getComments or All.getFooterComments.
    • updateComment that can be used as Comment.Footer.updateComment or All.updateFooterComment.
    • deleteComment that can be used as Comment.Footer.deleteComment or All.deleteFooterComment.
    • getCommentById that can be used as Comment.Inline.getCommentById or All.getInlineCommentById.
    • updateComment that can be used as Comment.Inline.updateComment or All.updateInlineComment.
    • deleteComment that can be used as Comment.Inline.deleteComment or All.deleteInlineComment.

  • The following methods are deprecated:

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.0.0

  • Added support for the following Attachment methods:

    • Get attachments that can be used as Attachment.getAttachments or All.getAttachments.
    • Get attachment by id that can be used as Attachment.getAttachmentById or All.getAttachmentByIds.
    • Delete attachment that can be used as Attachment.deleteAttachment or All.deleteAttachment.

  • Added support for the following Attachment.BlogPost method:

  • Added support for the following Attachment.CustomContent method:

  • Added support for the following Attachment.Label method:

  • Added support for the following Attachment.Page method:

  • Added support for the following Ancestor method:

  • Added support for the following BlogPost methods:

  • Added support for the following Children methods:

  • Added support for the following Comment.Attachment method:

  • Added support for the following Comment.Footer.Page method:

  • Added support for the following Comment.Inline.Page method:

  • Added support for the following Comment.Footer.BlogPost method:

  • Added support for the following Comment.Inline.BlogPost method:

  • Added support for the following Comment.Footer methods:

    • Get footer comments that can be used as Comment.Footer.getComments or All.getFooterComments.
    • Create footer comment that can be used as Comment.Footer.createComment or All.createFooterComment.
    • getCommentById that can be used as Comment.Footer.getCommentById or All.getFooterCommentById.
    • updateComment that can be used as Comment.Footer.updateComment or All.updateFooterComment.
    • deleteComment that can be used as Comment.Footer.deleteComment or All.deleteFooterComment.
    • Get children footer comments that can be used as Comment.Footer.getChildrenComments or All.getChildrenFooterComments.

  • Added support for the following Comment.Inline methods:

    • Get inline comments that can be used as Comment.Inline.getComments or All.getInlineComments.
    • Create inline comment that can be used as Comment.Inline.createComment or All.createInlineComment.
    • getCommentById that can be used as Comment.Inline.getCommentById or All.getInlineCommentById.
    • updateComment that can be used as Comment.Inline.updateComment or All.updateInlineComment.
    • deleteComment that can be used as Comment.Inline.deleteComment or All.deleteInlineComment.
    • Get children inline comments that can be used as Comment.Inline.getChildrenComments or All.getChildrenInlineComments.

  • Added support for the following Content method:

  • Added support for the following Content.Property.Attachment methods:

@managed-api/commons-core@managed-api/confluence-cloud-v2-core@stitch-it/runtime
@everything-registry/sub-chunk-576
2.3.0

7 months ago

2.2.0

8 months ago

2.1.0

2 years ago

2.0.0

2 years ago

1.1.0

2 years ago

1.0.0

2 years ago