@resolution/confluence-api-client 0.4.4 → 0.4.6

package/lib/openapi/v1/services/SpaceService.js

@@ -12,323 +12,326 @@ const space_1 = require("../models/space");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space */
 class SpaceService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Creates a new space that is only visible to the creator. This method is
-     * the same as the [Create space](#api-space-post) method with permissions
-     * set to the current user only. Note, currently you cannot set space
-     * labels when creating a space.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'Create Space(s)' global permission.
-     *
-     * @returns Returned if the space is created.
-     * @path {POST} /wiki/rest/api/space/_private
-     * @scopes-current write:confluence-space
-     * @scopes-beta read:space-details:confluence, write:space:confluence,
-     * write:space.permission:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-private-post
-     */
-    createPrivateSpace({ spaceCreate, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space/_private",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: spaceCreate,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.createPrivateSpace.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Creates a new space. Note, currently you cannot set space labels when
-     * creating a space.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'Create Space(s)' global permission.
-     *
-     * @returns Returned if the space is created.
-     * @path {POST} /wiki/rest/api/space
-     * @scopes-current write:confluence-space
-     * @scopes-beta read:space-details:confluence, write:space:confluence,
-     * write:space.permission:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-post
-     */
-    createSpace({ spaceCreate, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: spaceCreate,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.createSpace.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Permanently deletes a space without sending it to the trash. Note, the space
-     * will be deleted in a long running task.
-     * Therefore, the space may not be deleted yet when this method has
-     * returned. Clients should poll the status link that is returned in the
-     * response until the task completes.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'Admin' permission for the space.
-     *
-     * @returns Returns a pointer to the status of the space deletion task.
-     * @path {DELETE} /wiki/rest/api/space/{spaceKey}
-     * @scopes-current write:confluence-space
-     * @scopes-beta read:content.metadata:confluence, delete:space:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-delete
-     */
-    deleteSpace({ spaceKey, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space/{spaceKey}",
-            method: "DELETE",
-            pathParams: {
-                spaceKey,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            202: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.deleteSpace.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Deprecated, use [Confluence's v2
-     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
-     *
-     * Returns all content of a given type, in a space. The returned content is
-     * ordered by content ID in ascending order.
-     *
-     * Starting on Dec 10, 2024, if the expand query parameter is used with the
-     * `body.export_view` and/or `body.styled_view` properties, then the query limit
-     * parameter will be restricted to a maximum value of 25.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'View' permission for the space. Note, the returned list will only
-     * contain content that the current user has permission to view.
-     *
-     * @deprecated
-     * @returns Returned if the requested content is returned.
-     * @path {GET} /wiki/rest/api/space/{spaceKey}/content/{type}
-     * @scopes-current read:confluence-content.summary
-     * @scopes-beta read:content-details:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-content-type-get
-     */
-    getContentByTypeForSpace({ spaceKey, type, depth, expand, start, limit, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space/{spaceKey}/content/{type}",
-            method: "GET",
-            pathParams: {
-                spaceKey,
-                type,
-            },
-            query: {
-                depth,
-                expand,
-                start,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getContentByTypeForSpace.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Deprecated, use [Confluence's v2
-     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
-     *
-     * Returns all content in a space. The returned content is grouped by type
-     * (pages then blogposts), then ordered by content ID in ascending order.
-     *
-     * Starting on Dec 10, 2024, if the expand query parameter is used with the
-     * `body.export_view` and/or `body.styled_view` properties, then the query limit
-     * parameter will be restricted to a maximum value of 25.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'View' permission for the space. Note, the returned list will only
-     * contain content that the current user has permission to view.
-     *
-     * @deprecated
-     * @returns Returned if the requested content is returned.
-     * @path {GET} /wiki/rest/api/space/{spaceKey}/content
-     * @scopes-current read:confluence-content.summary
-     * @scopes-beta read:content-details:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-content-get
-     */
-    getContentForSpace({ spaceKey, depth, expand, start, limit, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space/{spaceKey}/content",
-            method: "GET",
-            pathParams: {
-                spaceKey,
-            },
-            query: {
-                depth,
-                expand,
-                start,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getContentForSpace.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Deprecated, use [Confluence's v2
-     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
-     *
-     * Returns a space. This includes information like the name, description,
-     * and permissions, but not the content in the space.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'View' permission for the space.
-     *
-     * @deprecated
-     * @returns Returned if the requested space is returned.
-     * @path {GET} /wiki/rest/api/space/{spaceKey}
-     * @scopes-current read:confluence-space.summary
-     * @scopes-beta read:content-details:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-get
-     */
-    getSpace({ spaceKey, expand, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space/{spaceKey}",
-            method: "GET",
-            pathParams: {
-                spaceKey,
-            },
-            query: {
-                expand,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getSpace.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Deprecated, use [Confluence's v2
-     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
-     *
-     * Returns all spaces. The returned spaces are ordered alphabetically in
-     * ascending order by space key.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to access the Confluence site ('Can use' global permission).
-     * Note, the returned list will only contain spaces that the current user
-     * has permission to view.
-     *
-     * @deprecated
-     * @returns Returned if the requested spaces are returned.
-     * @path {GET} /wiki/rest/api/space
-     * @scopes-current read:confluence-space.summary
-     * @scopes-beta read:content-details:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-get
-     */
-    getSpaces({ spaceKey, spaceId, type, status, label, favourite, favouriteUserKey, expand, start, limit, } = {}) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space",
-            method: "GET",
-            query: {
-                spaceKey,
-                spaceId,
-                type,
-                status,
-                label,
-                favourite,
-                favouriteUserKey,
-                expand,
-                start,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getSpaces.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Updates the name, description, or homepage of a space.
-     *
-     * -   For security reasons, permissions cannot be updated via the API and
-     * must be changed via the user interface instead.
-     * -   Currently you cannot set space labels when updating a space.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'Admin' permission for the space.
-     *
-     * @returns Returned if the space is updated.
-     * @path {PUT} /wiki/rest/api/space/{spaceKey}
-     * @scopes-current write:confluence-space
-     * @scopes-beta read:space-details:confluence, write:space:confluence,
-     * write:space.permission:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-put
-     */
-    updateSpace({ spaceKey, spaceUpdate, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/space/{spaceKey}",
-            method: "PUT",
-            pathParams: {
-                spaceKey,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: spaceUpdate,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.updateSpace.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Creates a new space that is only visible to the creator. This method is
+         * the same as the [Create space](#api-space-post) method with permissions
+         * set to the current user only. Note, currently you cannot set space
+         * labels when creating a space.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'Create Space(s)' global permission.
+         *
+         * @returns Returned if the space is created.
+         * @path {POST} /wiki/rest/api/space/_private
+         * @scopes-current write:confluence-space
+         * @scopes-beta read:space-details:confluence, write:space:confluence,
+         * write:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-private-post
+         */
+        this.createPrivateSpace = ({ spaceCreate, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space/_private",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: spaceCreate,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.createPrivateSpace.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Creates a new space. Note, currently you cannot set space labels when
+         * creating a space.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'Create Space(s)' global permission.
+         *
+         * @returns Returned if the space is created.
+         * @path {POST} /wiki/rest/api/space
+         * @scopes-current write:confluence-space
+         * @scopes-beta read:space-details:confluence, write:space:confluence,
+         * write:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-post
+         */
+        this.createSpace = ({ spaceCreate, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: spaceCreate,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.createSpace.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Permanently deletes a space without sending it to the trash. Note, the space
+         * will be deleted in a long running task.
+         * Therefore, the space may not be deleted yet when this method has
+         * returned. Clients should poll the status link that is returned in the
+         * response until the task completes.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'Admin' permission for the space.
+         *
+         * @returns Returns a pointer to the status of the space deletion task.
+         * @path {DELETE} /wiki/rest/api/space/{spaceKey}
+         * @scopes-current write:confluence-space
+         * @scopes-beta read:content.metadata:confluence, delete:space:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-delete
+         */
+        this.deleteSpace = ({ spaceKey, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space/{spaceKey}",
+                method: "DELETE",
+                pathParams: {
+                    spaceKey,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                202: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.deleteSpace.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Deprecated, use [Confluence's v2
+         * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+         *
+         * Returns all content of a given type, in a space. The returned content is
+         * ordered by content ID in ascending order.
+         *
+         * Starting on Dec 10, 2024, if the expand query parameter is used with the
+         * `body.export_view` and/or `body.styled_view` properties, then the query limit
+         * parameter will be restricted to a maximum value of 25.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'View' permission for the space. Note, the returned list will only
+         * contain content that the current user has permission to view.
+         *
+         * @deprecated
+         * @returns Returned if the requested content is returned.
+         * @path {GET} /wiki/rest/api/space/{spaceKey}/content/{type}
+         * @scopes-current read:confluence-content.summary
+         * @scopes-beta read:content-details:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-content-type-get
+         */
+        this.getContentByTypeForSpace = ({ spaceKey, type, depth, expand, start, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space/{spaceKey}/content/{type}",
+                method: "GET",
+                pathParams: {
+                    spaceKey,
+                    type,
+                },
+                query: {
+                    depth,
+                    expand,
+                    start,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getContentByTypeForSpace.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Deprecated, use [Confluence's v2
+         * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+         *
+         * Returns all content in a space. The returned content is grouped by type
+         * (pages then blogposts), then ordered by content ID in ascending order.
+         *
+         * Starting on Dec 10, 2024, if the expand query parameter is used with the
+         * `body.export_view` and/or `body.styled_view` properties, then the query limit
+         * parameter will be restricted to a maximum value of 25.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'View' permission for the space. Note, the returned list will only
+         * contain content that the current user has permission to view.
+         *
+         * @deprecated
+         * @returns Returned if the requested content is returned.
+         * @path {GET} /wiki/rest/api/space/{spaceKey}/content
+         * @scopes-current read:confluence-content.summary
+         * @scopes-beta read:content-details:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-content-get
+         */
+        this.getContentForSpace = ({ spaceKey, depth, expand, start, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space/{spaceKey}/content",
+                method: "GET",
+                pathParams: {
+                    spaceKey,
+                },
+                query: {
+                    depth,
+                    expand,
+                    start,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getContentForSpace.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Deprecated, use [Confluence's v2
+         * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+         *
+         * Returns a space. This includes information like the name, description,
+         * and permissions, but not the content in the space.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'View' permission for the space.
+         *
+         * @deprecated
+         * @returns Returned if the requested space is returned.
+         * @path {GET} /wiki/rest/api/space/{spaceKey}
+         * @scopes-current read:confluence-space.summary
+         * @scopes-beta read:content-details:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-get
+         */
+        this.getSpace = ({ spaceKey, expand, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space/{spaceKey}",
+                method: "GET",
+                pathParams: {
+                    spaceKey,
+                },
+                query: {
+                    expand,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getSpace.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Deprecated, use [Confluence's v2
+         * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+         *
+         * Returns all spaces. The returned spaces are ordered alphabetically in
+         * ascending order by space key.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to access the Confluence site ('Can use' global permission).
+         * Note, the returned list will only contain spaces that the current user
+         * has permission to view.
+         *
+         * @deprecated
+         * @returns Returned if the requested spaces are returned.
+         * @path {GET} /wiki/rest/api/space
+         * @scopes-current read:confluence-space.summary
+         * @scopes-beta read:content-details:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-get
+         */
+        this.getSpaces = ({ spaceKey, spaceId, type, status, label, favourite, favouriteUserKey, expand, start, limit, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space",
+                method: "GET",
+                query: {
+                    spaceKey,
+                    spaceId,
+                    type,
+                    status,
+                    label,
+                    favourite,
+                    favouriteUserKey,
+                    expand,
+                    start,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getSpaces.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Updates the name, description, or homepage of a space.
+         *
+         * -   For security reasons, permissions cannot be updated via the API and
+         * must be changed via the user interface instead.
+         * -   Currently you cannot set space labels when updating a space.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'Admin' permission for the space.
+         *
+         * @returns Returned if the space is updated.
+         * @path {PUT} /wiki/rest/api/space/{spaceKey}
+         * @scopes-current write:confluence-space
+         * @scopes-beta read:space-details:confluence, write:space:confluence,
+         * write:space.permission:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space#api-wiki-rest-api-space-spacekey-put
+         */
+        this.updateSpace = ({ spaceKey, spaceUpdate, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/space/{spaceKey}",
+                method: "PUT",
+                pathParams: {
+                    spaceKey,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: spaceUpdate,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.updateSpace.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpaceService.getSpaces.response", zod_1.z