@resolution/confluence-api-client 0.4.3 → 0.4.5

package/lib/openapi/v2/services/CommentService.js

@@ -12,638 +12,641 @@ const common_1 = require("../models/common");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment */
 class CommentService extends CommonHttpService_1.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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-post
-     */
-    createFooterComment({ createFooterCommentModel, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/footer-comments",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: createFooterCommentModel,
-        })
-            .then(this.getClientInstance().responseHandler({
-            201: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.createFooterComment.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-post
-     */
-    createInlineComment({ createInlineCommentModel, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/inline-comments",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: createInlineCommentModel,
-        })
-            .then(this.getClientInstance().responseHandler({
-            201: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.createInlineComment.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-comment-id-delete
-     */
-    deleteFooterComment({ commentId, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/footer-comments/{comment-id}",
-            method: "DELETE",
-            pathParams: {
-                "comment-id": commentId,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-comment-id-delete
-     */
-    deleteInlineComment({ commentId, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/inline-comments/{comment-id}",
-            method: "DELETE",
-            pathParams: {
-                "comment-id": commentId,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-attachments-id-footer-comments-get
-     */
-    getAttachmentComments({ id, bodyFormat, cursor, limit, sort, version, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/attachments/{id}/footer-comments",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                "body-format": bodyFormat,
-                cursor,
-                limit,
-                sort,
-                version,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getAttachmentComments.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-blogposts-id-footer-comments-get
-     */
-    getBlogPostFooterComments({ id, bodyFormat, sort, cursor, limit, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/blogposts/{id}/footer-comments",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                "body-format": bodyFormat,
-                sort,
-                cursor,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getBlogPostFooterComments.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-blogposts-id-inline-comments-get
-     */
-    getBlogPostInlineComments({ id, bodyFormat, sort, cursor, limit, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/blogposts/{id}/inline-comments",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                "body-format": bodyFormat,
-                sort,
-                cursor,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getBlogPostInlineComments.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-custom-content-id-footer-comments-get
-     */
-    getCustomContentComments({ id, bodyFormat, cursor, limit, sort, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/custom-content/{id}/footer-comments",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                "body-format": bodyFormat,
-                cursor,
-                limit,
-                sort,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getCustomContentComments.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-comment-id-get
-     */
-    getFooterCommentById({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/footer-comments/{comment-id}",
-            method: "GET",
-            pathParams: {
-                "comment-id": commentId,
-            },
-            query: {
-                "body-format": bodyFormat,
-                version,
-                "include-properties": includeProperties,
-                "include-operations": includeOperations,
-                "include-likes": includeLikes,
-                "include-versions": includeVersions,
-                "include-version": includeVersion,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getFooterCommentById.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-id-children-get
-     */
-    getFooterCommentChildren({ id, bodyFormat, sort, cursor, limit, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/footer-comments/{id}/children",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                "body-format": bodyFormat,
-                sort,
-                cursor,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getFooterCommentChildren.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-get
-     */
-    getFooterComments({ bodyFormat, sort, cursor, limit, } = {}) {
-        return this.getClientInstance()
-            .request({
-            path: "/footer-comments",
-            method: "GET",
-            query: {
-                "body-format": bodyFormat,
-                sort,
-                cursor,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getFooterComments.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-comment-id-get
-     */
-    getInlineCommentById({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/inline-comments/{comment-id}",
-            method: "GET",
-            pathParams: {
-                "comment-id": commentId,
-            },
-            query: {
-                "body-format": bodyFormat,
-                version,
-                "include-properties": includeProperties,
-                "include-operations": includeOperations,
-                "include-likes": includeLikes,
-                "include-versions": includeVersions,
-                "include-version": includeVersion,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getInlineCommentById.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-id-children-get
-     */
-    getInlineCommentChildren({ id, bodyFormat, sort, cursor, limit, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/inline-comments/{id}/children",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                "body-format": bodyFormat,
-                sort,
-                cursor,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getInlineCommentChildren.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-get
-     */
-    getInlineComments({ bodyFormat, sort, cursor, limit, } = {}) {
-        return this.getClientInstance()
-            .request({
-            path: "/inline-comments",
-            method: "GET",
-            query: {
-                "body-format": bodyFormat,
-                sort,
-                cursor,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getInlineComments.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-pages-id-footer-comments-get
-     */
-    getPageFooterComments({ id, bodyFormat, sort, cursor, limit, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/pages/{id}/footer-comments",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                "body-format": bodyFormat,
-                sort,
-                cursor,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getPageFooterComments.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-pages-id-inline-comments-get
-     */
-    getPageInlineComments({ id, bodyFormat, sort, cursor, limit, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/pages/{id}/inline-comments",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                "body-format": bodyFormat,
-                sort,
-                cursor,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getPageInlineComments.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-comment-id-put
-     */
-    updateFooterComment({ commentId, requestBody, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/footer-comments/{comment-id}",
-            method: "PUT",
-            pathParams: {
-                "comment-id": commentId,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: requestBody,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.updateFooterComment.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-comment-id-put
-     */
-    updateInlineComment({ commentId, updateInlineCommentModel, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/inline-comments/{comment-id}",
-            method: "PUT",
-            pathParams: {
-                "comment-id": commentId,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: updateInlineCommentModel,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.updateInlineComment.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-post
+         */
+        this.createFooterComment = ({ createFooterCommentModel, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/footer-comments",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: createFooterCommentModel,
+            })
+                .then(this.getClientInstance().responseHandler({
+                201: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.createFooterComment.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-post
+         */
+        this.createInlineComment = ({ createInlineCommentModel, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/inline-comments",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: createInlineCommentModel,
+            })
+                .then(this.getClientInstance().responseHandler({
+                201: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.createInlineComment.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-comment-id-delete
+         */
+        this.deleteFooterComment = ({ commentId, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/footer-comments/{comment-id}",
+                method: "DELETE",
+                pathParams: {
+                    "comment-id": commentId,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-comment-id-delete
+         */
+        this.deleteInlineComment = ({ commentId, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/inline-comments/{comment-id}",
+                method: "DELETE",
+                pathParams: {
+                    "comment-id": commentId,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-attachments-id-footer-comments-get
+         */
+        this.getAttachmentComments = ({ id, bodyFormat, cursor, limit, sort, version, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/attachments/{id}/footer-comments",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    cursor,
+                    limit,
+                    sort,
+                    version,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getAttachmentComments.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-blogposts-id-footer-comments-get
+         */
+        this.getBlogPostFooterComments = ({ id, bodyFormat, sort, cursor, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/blogposts/{id}/footer-comments",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    sort,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getBlogPostFooterComments.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-blogposts-id-inline-comments-get
+         */
+        this.getBlogPostInlineComments = ({ id, bodyFormat, sort, cursor, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/blogposts/{id}/inline-comments",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    sort,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getBlogPostInlineComments.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-custom-content-id-footer-comments-get
+         */
+        this.getCustomContentComments = ({ id, bodyFormat, cursor, limit, sort, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/custom-content/{id}/footer-comments",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    cursor,
+                    limit,
+                    sort,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getCustomContentComments.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-comment-id-get
+         */
+        this.getFooterCommentById = ({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/footer-comments/{comment-id}",
+                method: "GET",
+                pathParams: {
+                    "comment-id": commentId,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    version,
+                    "include-properties": includeProperties,
+                    "include-operations": includeOperations,
+                    "include-likes": includeLikes,
+                    "include-versions": includeVersions,
+                    "include-version": includeVersion,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getFooterCommentById.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-id-children-get
+         */
+        this.getFooterCommentChildren = ({ id, bodyFormat, sort, cursor, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/footer-comments/{id}/children",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    sort,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getFooterCommentChildren.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-get
+         */
+        this.getFooterComments = ({ bodyFormat, sort, cursor, limit, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/footer-comments",
+                method: "GET",
+                query: {
+                    "body-format": bodyFormat,
+                    sort,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getFooterComments.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-comment-id-get
+         */
+        this.getInlineCommentById = ({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/inline-comments/{comment-id}",
+                method: "GET",
+                pathParams: {
+                    "comment-id": commentId,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    version,
+                    "include-properties": includeProperties,
+                    "include-operations": includeOperations,
+                    "include-likes": includeLikes,
+                    "include-versions": includeVersions,
+                    "include-version": includeVersion,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getInlineCommentById.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-id-children-get
+         */
+        this.getInlineCommentChildren = ({ id, bodyFormat, sort, cursor, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/inline-comments/{id}/children",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    sort,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getInlineCommentChildren.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-get
+         */
+        this.getInlineComments = ({ bodyFormat, sort, cursor, limit, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/inline-comments",
+                method: "GET",
+                query: {
+                    "body-format": bodyFormat,
+                    sort,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getInlineComments.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-pages-id-footer-comments-get
+         */
+        this.getPageFooterComments = ({ id, bodyFormat, sort, cursor, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/pages/{id}/footer-comments",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    sort,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getPageFooterComments.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-pages-id-inline-comments-get
+         */
+        this.getPageInlineComments = ({ id, bodyFormat, sort, cursor, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/pages/{id}/inline-comments",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    sort,
+                    cursor,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getPageInlineComments.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-footer-comments-comment-id-put
+         */
+        this.updateFooterComment = ({ commentId, requestBody, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/footer-comments/{comment-id}",
+                method: "PUT",
+                pathParams: {
+                    "comment-id": commentId,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: requestBody,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.updateFooterComment.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment#api-inline-comments-comment-id-put
+         */
+        this.updateInlineComment = ({ commentId, updateInlineCommentModel, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/inline-comments/{comment-id}",
+                method: "PUT",
+                pathParams: {
+                    "comment-id": commentId,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: updateInlineCommentModel,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.updateInlineComment.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getAttachmentComments.response", zod_1.z