@resolution/confluence-api-client 0.4.3 → 0.4.5

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

@@ -12,302 +12,305 @@ const customContent_1 = require("../models/customContent");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content */
 class CustomContentService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Creates a new custom content in the given space, page, blogpost or other custom
-     * content.
-     *
-     * Only one of `spaceId`, `pageId`, `blogPostId`, or `customContentId` is required
-     * in the request body.
-     * **[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 custom content in the space.
-     *
-     * @returns Returned if the requested custom content is created successfully.
-     * @path {POST} /custom-content
-     * @scopes-current write:custom-content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-post
-     */
-    createCustomContent({ requestBody, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/custom-content",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: requestBody,
-        })
-            .then(this.getClientInstance().responseHandler({
-            201: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.createCustomContent.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Delete a custom content by id.
-     *
-     * Deleting a custom content will either move it to the trash or permanently
-     * delete it (purge it), depending on the apiSupport.
-     * To permanently delete a **trashed** custom content, the endpoint must be called
-     * with the following param `purge=true`.
-     *
-     * **[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 custom content in the space.
-     * Permission to administer the space (if attempting to purge).
-     *
-     * @path {DELETE} /custom-content/{id}
-     * @scopes-current delete:custom-content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-id-delete
-     */
-    deleteCustomContent({ id, purge, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/custom-content/{id}",
-            method: "DELETE",
-            pathParams: {
-                id,
-            },
-            query: {
-                purge,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Returns a specific piece of custom content.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to view the custom content, the container of the custom content, and
-     * the corresponding space (if different from the container).
-     *
-     * @returns Returned if the requested custom content is returned.
-     * @path {GET} /custom-content/{id}
-     * @scopes-current read:custom-content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-id-get
-     */
-    getCustomContentById({ id, bodyFormat, version, includeLabels, includeProperties, includeOperations, includeVersions, includeVersion, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/custom-content/{id}",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                "body-format": bodyFormat,
-                version,
-                "include-labels": includeLabels,
-                "include-properties": includeProperties,
-                "include-operations": includeOperations,
-                "include-versions": includeVersions,
-                "include-version": includeVersion,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentById.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns all custom content for a given type. 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, the container of the custom content, and
-     * the corresponding space (if different from the container).
-     *
-     * @returns Returned if the requested custom content is returned.
-     * @path {GET} /custom-content
-     * @scopes-current read:custom-content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-get
-     */
-    getCustomContentByType({ type, id, spaceId, sort, cursor, limit, bodyFormat, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/custom-content",
-            method: "GET",
-            query: {
-                type,
-                id,
-                "space-id": spaceId,
-                sort,
-                cursor,
-                limit,
-                "body-format": bodyFormat,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByType.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns all custom content for a given type within a given blogpost. 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, the container of the custom content
-     * (blog post), and the corresponding space.
-     *
-     * @returns Returned if the requested custom content is returned.
-     * @path {GET} /blogposts/{id}/custom-content
-     * @scopes-current read:custom-content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-blogposts-id-custom-content-get
-     */
-    getCustomContentByTypeInBlogPost({ id, type, sort, cursor, limit, bodyFormat, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/blogposts/{id}/custom-content",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                type,
-                sort,
-                cursor,
-                limit,
-                "body-format": bodyFormat,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByTypeInBlogPost.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns all custom content for a given type within a given 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 custom content, the container of the custom content
-     * (page), and the corresponding space.
-     *
-     * @returns Returned if the requested custom content is returned.
-     * @path {GET} /pages/{id}/custom-content
-     * @scopes-current read:custom-content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-pages-id-custom-content-get
-     */
-    getCustomContentByTypeInPage({ id, type, sort, cursor, limit, bodyFormat, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/pages/{id}/custom-content",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                type,
-                sort,
-                cursor,
-                limit,
-                "body-format": bodyFormat,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByTypeInPage.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns all custom content for a given type within a given space. 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 the corresponding space.
-     *
-     * @returns Returned if the requested custom content is returned.
-     * @path {GET} /spaces/{id}/custom-content
-     * @scopes-current read:custom-content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-spaces-id-custom-content-get
-     */
-    getCustomContentByTypeInSpace({ id, type, cursor, limit, bodyFormat, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/spaces/{id}/custom-content",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                type,
-                cursor,
-                limit,
-                "body-format": bodyFormat,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByTypeInSpace.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Update a custom content by id.
-     *
-     * `spaceId` is always required and maximum one of `pageId`, `blogPostId`, or
-     * `customContentId` is allowed in the request body.
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to view the content of the page or blogpost and its corresponding
-     * space. Permission to update custom content in the space.
-     *
-     * @returns Returned if the requested custom content is updated successfully.
-     * @path {PUT} /custom-content/{id}
-     * @scopes-current write:custom-content:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-id-put
-     */
-    updateCustomContent({ id, requestBody, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/custom-content/{id}",
-            method: "PUT",
-            pathParams: {
-                id,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: requestBody,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.updateCustomContent.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Creates a new custom content in the given space, page, blogpost or other custom
+         * content.
+         *
+         * Only one of `spaceId`, `pageId`, `blogPostId`, or `customContentId` is required
+         * in the request body.
+         * **[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 custom content in the space.
+         *
+         * @returns Returned if the requested custom content is created successfully.
+         * @path {POST} /custom-content
+         * @scopes-current write:custom-content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-post
+         */
+        this.createCustomContent = ({ requestBody, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/custom-content",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: requestBody,
+            })
+                .then(this.getClientInstance().responseHandler({
+                201: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.createCustomContent.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Delete a custom content by id.
+         *
+         * Deleting a custom content will either move it to the trash or permanently
+         * delete it (purge it), depending on the apiSupport.
+         * To permanently delete a **trashed** custom content, the endpoint must be called
+         * with the following param `purge=true`.
+         *
+         * **[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 custom content in the space.
+         * Permission to administer the space (if attempting to purge).
+         *
+         * @path {DELETE} /custom-content/{id}
+         * @scopes-current delete:custom-content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-id-delete
+         */
+        this.deleteCustomContent = ({ id, purge, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/custom-content/{id}",
+                method: "DELETE",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    purge,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Returns a specific piece of custom content.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to view the custom content, the container of the custom content, and
+         * the corresponding space (if different from the container).
+         *
+         * @returns Returned if the requested custom content is returned.
+         * @path {GET} /custom-content/{id}
+         * @scopes-current read:custom-content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-id-get
+         */
+        this.getCustomContentById = ({ id, bodyFormat, version, includeLabels, includeProperties, includeOperations, includeVersions, includeVersion, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/custom-content/{id}",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    "body-format": bodyFormat,
+                    version,
+                    "include-labels": includeLabels,
+                    "include-properties": includeProperties,
+                    "include-operations": includeOperations,
+                    "include-versions": includeVersions,
+                    "include-version": includeVersion,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentById.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns all custom content for a given type. 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, the container of the custom content, and
+         * the corresponding space (if different from the container).
+         *
+         * @returns Returned if the requested custom content is returned.
+         * @path {GET} /custom-content
+         * @scopes-current read:custom-content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-get
+         */
+        this.getCustomContentByType = ({ type, id, spaceId, sort, cursor, limit, bodyFormat, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/custom-content",
+                method: "GET",
+                query: {
+                    type,
+                    id,
+                    "space-id": spaceId,
+                    sort,
+                    cursor,
+                    limit,
+                    "body-format": bodyFormat,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByType.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns all custom content for a given type within a given blogpost. 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, the container of the custom content
+         * (blog post), and the corresponding space.
+         *
+         * @returns Returned if the requested custom content is returned.
+         * @path {GET} /blogposts/{id}/custom-content
+         * @scopes-current read:custom-content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-blogposts-id-custom-content-get
+         */
+        this.getCustomContentByTypeInBlogPost = ({ id, type, sort, cursor, limit, bodyFormat, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/blogposts/{id}/custom-content",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    type,
+                    sort,
+                    cursor,
+                    limit,
+                    "body-format": bodyFormat,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByTypeInBlogPost.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns all custom content for a given type within a given 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 custom content, the container of the custom content
+         * (page), and the corresponding space.
+         *
+         * @returns Returned if the requested custom content is returned.
+         * @path {GET} /pages/{id}/custom-content
+         * @scopes-current read:custom-content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-pages-id-custom-content-get
+         */
+        this.getCustomContentByTypeInPage = ({ id, type, sort, cursor, limit, bodyFormat, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/pages/{id}/custom-content",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    type,
+                    sort,
+                    cursor,
+                    limit,
+                    "body-format": bodyFormat,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByTypeInPage.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns all custom content for a given type within a given space. 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 the corresponding space.
+         *
+         * @returns Returned if the requested custom content is returned.
+         * @path {GET} /spaces/{id}/custom-content
+         * @scopes-current read:custom-content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-spaces-id-custom-content-get
+         */
+        this.getCustomContentByTypeInSpace = ({ id, type, cursor, limit, bodyFormat, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/spaces/{id}/custom-content",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    type,
+                    cursor,
+                    limit,
+                    "body-format": bodyFormat,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.getCustomContentByTypeInSpace.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Update a custom content by id.
+         *
+         * `spaceId` is always required and maximum one of `pageId`, `blogPostId`, or
+         * `customContentId` is allowed in the request body.
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to view the content of the page or blogpost and its corresponding
+         * space. Permission to update custom content in the space.
+         *
+         * @returns Returned if the requested custom content is updated successfully.
+         * @path {PUT} /custom-content/{id}
+         * @scopes-current write:custom-content:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-custom-content#api-custom-content-id-put
+         */
+        this.updateCustomContent = ({ id, requestBody, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/custom-content/{id}",
+                method: "PUT",
+                pathParams: {
+                    id,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: requestBody,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("CustomContentService.updateCustomContent.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CustomContentService.getCustomContentByTypeInBlogPost.response", zod_1.z