@resolution/confluence-api-client 0.2.0

package/lib/openapi/v2/services/CommentService.d.ts

@@ -0,0 +1,713 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type AttachmentCommentModel, type BlogPostCommentModel, type BlogPostInlineCommentModel, type ChildrenCommentModel, type CommentSortOrder, type CreateFooterCommentModel, type CreateInlineCommentModel, type CustomContentCommentModel, type FooterCommentModel, type InlineCommentChildrenModel, type InlineCommentModel, type PageCommentModel, type PageInlineCommentModel, type UpdateFooterCommentModel, type UpdateInlineCommentModel } from "../models/comment";
+import { type MultiEntityLinks, type PrimaryBodyRepresentation, type PrimaryBodyRepresentationSingle } from "../models/common";
+export declare class CommentService extends CommonHttpService {
+    /**
+     * Create a footer comment.
+     *
+     * The footer comment can be made against several locations:
+     * - at the top level (specifying pageId or blogPostId in the request body)
+     * - as a reply (specifying parentCommentId in the request body)
+     * - against an attachment (note: this is different than the comments added via
+     * the attachment properties page on the UI, which are referred to as version
+     * comments)
+     * - against a custom content
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space. Permission to create comments in the space.
+     *
+     * @returns Returned if the footer comment is created.
+     * @path {POST} /footer-comments
+     * @scopes-current write:comment:confluence
+     */
+    createFooterComment({ createFooterCommentModel, }: {
+        /** The footer comment to be created */
+        createFooterCommentModel: CreateFooterCommentModel;
+    }): Promise<FooterCommentModel & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Create an inline comment. This can be at the top level (specifying pageId or
+     * blogPostId in the request body)
+     * or as a reply (specifying parentCommentId in the request body). Note the
+     * inlineCommentProperties object in the
+     * request body is used to select the text the inline comment should be tied to.
+     * This is what determines the text
+     * highlighting when viewing a page in Confluence.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space. Permission to create comments in the space.
+     *
+     * @returns Returned if the inline comment is created.
+     * @path {POST} /inline-comments
+     * @scopes-current write:comment:confluence
+     */
+    createInlineComment({ createInlineCommentModel, }: {
+        /** The inline comment to be created */
+        createInlineCommentModel: CreateInlineCommentModel;
+    }): Promise<InlineCommentModel & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Deletes a footer comment. This is a permanent deletion and cannot be reverted.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space. Permission to delete comments in the space.
+     *
+     * @path {DELETE} /footer-comments/{comment-id}
+     * @scopes-current delete:comment:confluence
+     */
+    deleteFooterComment({ commentId, }: {
+        /** The ID of the comment to be retrieved. */
+        commentId: number;
+    }): Promise<void>;
+    /**
+     * Deletes an inline comment. This is a permanent deletion and cannot be reverted.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space. Permission to delete comments in the space.
+     *
+     * @path {DELETE} /inline-comments/{comment-id}
+     * @scopes-current delete:comment:confluence
+     */
+    deleteInlineComment({ commentId, }: {
+        /** The ID of the comment to be deleted. */
+        commentId: number;
+    }): Promise<void>;
+    /**
+     * Returns the comments of the specific attachment.
+     * The number of results is limited by the `limit` parameter and additional
+     * results (if available) will be available through
+     * the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment and its corresponding containers.
+     *
+     * @returns Returned if the attachment comments were successfully retrieved
+     * @path {GET} /attachments/{id}/footer-comments
+     * @scopes-current read:comment:confluence
+     */
+    getAttachmentComments({ id, bodyFormat, cursor, limit, sort, version, }: {
+        /** The ID of the attachment for which comments should be returned. */
+        id: string;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of comments per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+        /**
+         * Version number of the attachment to retrieve comments for. If no version
+         * provided, retrieves comments for the latest version.
+         */
+        version?: number;
+    }): Promise<{
+        results?: AttachmentCommentModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the root footer comments of specific blog post. The number of results
+     * is limited by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the blog post and its corresponding space.
+     *
+     * @returns Returned if the requested footer comments are returned.
+     * @path {GET} /blogposts/{id}/footer-comments
+     * @scopes-current read:comment:confluence
+     */
+    getBlogPostFooterComments({ id, bodyFormat, sort, cursor, limit, }: {
+        /** The ID of the blog post for which footer comments should be returned. */
+        id: number;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of footer comments per result to return. If more results exist,
+         * use the `Link` header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: BlogPostCommentModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the root inline comments of specific blog post. The number of results
+     * is limited by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the blog post and its corresponding space.
+     *
+     * @returns Returned if the requested inline comments are returned.
+     * @path {GET} /blogposts/{id}/inline-comments
+     * @scopes-current read:comment:confluence
+     */
+    getBlogPostInlineComments({ id, bodyFormat, sort, cursor, limit, }: {
+        /** The ID of the blog post for which inline comments should be returned. */
+        id: number;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of inline comments per result to return. If more results exist,
+         * use the `Link` header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: BlogPostInlineCommentModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the comments of the specific custom content.
+     * The number of results is limited by the `limit` parameter and additional
+     * results (if available) will be available through
+     * the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the custom content and its corresponding containers.
+     *
+     * @returns Returned if the custom content comments were successfully retrieved
+     * @path {GET} /custom-content/{id}/footer-comments
+     * @scopes-current read:comment:confluence
+     */
+    getCustomContentComments({ id, bodyFormat, cursor, limit, sort, }: {
+        /** The ID of the custom content for which comments should be returned. */
+        id: number;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of comments per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+    }): Promise<{
+        results?: CustomContentCommentModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves a footer comment by id
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the container and its corresponding space.
+     *
+     * @returns Returned if the footer comment is successfully retrieved.
+     * @path {GET} /footer-comments/{comment-id}
+     * @scopes-current read:comment:confluence
+     */
+    getFooterCommentById({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }: {
+        /** The ID of the comment to be retrieved. */
+        commentId: number;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentationSingle;
+        /**
+         * Allows you to retrieve a previously published version. Specify the previous
+         * version's number to retrieve its details.
+         */
+        version?: number;
+        /**
+         * Includes content properties associated with this footer comment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeProperties?: boolean;
+        /**
+         * Includes operations associated with this footer comment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeOperations?: boolean;
+        /**
+         * Includes likes associated with this footer comment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeLikes?: boolean;
+        /**
+         * Includes versions associated with this footer comment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeVersions?: boolean;
+        /**
+         * Includes the current version associated with this footer comment in the
+         * response.
+         * By default this is included and can be omitted by setting the value to `false`.
+         */
+        includeVersion?: boolean;
+    }): Promise<FooterCommentModel & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Returns the children footer comments of specific comment. The number of results
+     * is limited by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page and its corresponding space.
+     *
+     * @returns Returned if the requested footer comments are returned.
+     * @path {GET} /footer-comments/{id}/children
+     * @scopes-current read:comment:confluence
+     */
+    getFooterCommentChildren({ id, bodyFormat, sort, cursor, limit, }: {
+        /**
+         * The ID of the parent comment for which footer comment children should be
+         * returned.
+         */
+        id: number;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of footer comments per result to return. If more results exist,
+         * use the `Link` header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: ChildrenCommentModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns all footer comments. The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the container and its corresponding space.
+     *
+     * @returns Returned if the requested footer comments are returned.
+     * @path {GET} /footer-comments
+     * @scopes-current read:comment:confluence
+     */
+    getFooterComments({ bodyFormat, sort, cursor, limit, }: {
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of footer comments per result to return. If more results exist,
+         * use the `Link` header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: FooterCommentModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves an inline comment by id
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space.
+     *
+     * @returns Returned if the inline comment is successfully retrieved.
+     * @path {GET} /inline-comments/{comment-id}
+     * @scopes-current read:comment:confluence
+     */
+    getInlineCommentById({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }: {
+        /** The ID of the comment to be retrieved. */
+        commentId: number;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentationSingle;
+        /**
+         * Allows you to retrieve a previously published version. Specify the previous
+         * version's number to retrieve its details.
+         */
+        version?: number;
+        /**
+         * Includes content properties associated with this inline comment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeProperties?: boolean;
+        /**
+         * Includes operations associated with this inline comment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeOperations?: boolean;
+        /**
+         * Includes likes associated with this inline comment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeLikes?: boolean;
+        /**
+         * Includes versions associated with this inline comment in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeVersions?: boolean;
+        /**
+         * Includes the current version associated with this inline comment in the
+         * response.
+         * By default this is included and can be omitted by setting the value to `false`.
+         */
+        includeVersion?: boolean;
+    }): Promise<InlineCommentModel & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Returns the children inline comments of specific comment. The number of results
+     * is limited by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page and its corresponding space.
+     *
+     * @returns Returned if the requested footer comments are returned.
+     * @path {GET} /inline-comments/{id}/children
+     * @scopes-current read:comment:confluence
+     */
+    getInlineCommentChildren({ id, bodyFormat, sort, cursor, limit, }: {
+        /**
+         * The ID of the parent comment for which inline comment children should be
+         * returned.
+         */
+        id: number;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of footer comments per result to return. If more results exist,
+         * use the `Link` header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: InlineCommentChildrenModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns all inline comments. The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page and its corresponding space.
+     *
+     * @returns Returned if the requested inline comments are returned.
+     * @path {GET} /inline-comments
+     * @scopes-current read:comment:confluence
+     */
+    getInlineComments({ bodyFormat, sort, cursor, limit, }: {
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of footer comments per result to return. If more results exist,
+         * use the `Link` header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: InlineCommentModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the root footer comments of specific page. The number of results is
+     * limited by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page and its corresponding space.
+     *
+     * @returns Returned if the requested footer comments are returned.
+     * @path {GET} /pages/{id}/footer-comments
+     * @scopes-current read:comment:confluence
+     */
+    getPageFooterComments({ id, bodyFormat, sort, cursor, limit, }: {
+        /** The ID of the page for which footer comments should be returned. */
+        id: number;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of footer comments per result to return. If more results exist,
+         * use the `Link` header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: PageCommentModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the root inline comments of specific page. The number of results is
+     * limited by the `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page and its corresponding space.
+     *
+     * @returns Returned if the requested inline comments are returned.
+     * @path {GET} /pages/{id}/inline-comments
+     * @scopes-current read:comment:confluence
+     */
+    getPageInlineComments({ id, bodyFormat, sort, cursor, limit, }: {
+        /** The ID of the page for which inline comments should be returned. */
+        id: number;
+        /**
+         * The content format type to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /** Used to sort the result by a particular field. */
+        sort?: CommentSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of inline comments per result to return. If more results exist,
+         * use the `Link` header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: PageInlineCommentModel[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Update a footer comment. This can be used to update the body text of a comment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space. Permission to create comments in the space.
+     *
+     * @returns Returned if the footer comment is updated successfully
+     * @path {PUT} /footer-comments/{comment-id}
+     * @scopes-current write:comment:confluence
+     */
+    updateFooterComment({ commentId, requestBody, }: {
+        /** The ID of the comment to be retrieved. */
+        commentId: number;
+        /** The footer comment to be created */
+        requestBody: UpdateFooterCommentModel & ({
+            _links?: {
+                /** Base url of the Confluence site. */
+                base?: string;
+            } & {
+                [key: string]: unknown;
+            };
+        } & {
+            [key: string]: unknown;
+        });
+    }): Promise<FooterCommentModel>;
+    /**
+     * Update an inline comment. This can be used to update the body text of a comment
+     * and/or to resolve the comment
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blogpost and its corresponding
+     * space. Permission to create comments in the space.
+     *
+     * @returns Returned if the inline comment is updated successfully.
+     * @path {PUT} /inline-comments/{comment-id}
+     * @scopes-current write:comment:confluence
+     */
+    updateInlineComment({ commentId, updateInlineCommentModel, }: {
+        /** The ID of the comment to be retrieved. */
+        commentId: number;
+        /** The inline comment to be updated */
+        updateInlineCommentModel: UpdateInlineCommentModel;
+    }): Promise<InlineCommentModel & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    static initialize(): void;
+}