@resolution/confluence-api-client 0.2.0

package/lib/openapi/v1/services/SpaceService.d.ts

@@ -0,0 +1,479 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type ContentArray, type GenericLinks, type LongTask, type Space } from "../models/common";
+import { type SpaceArray, type SpaceCreate, type SpaceUpdate } from "../models/space";
+export declare class SpaceService extends 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
+     */
+    createPrivateSpace({ spaceCreate, }: {
+        /** The space to be created. */
+        spaceCreate: SpaceCreate;
+    }): Promise<Space | null>;
+    /**
+     * 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
+     */
+    createSpace({ spaceCreate, }: {
+        /** The space to be created. */
+        spaceCreate: SpaceCreate;
+    }): Promise<Space | null>;
+    /**
+     * 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
+     */
+    deleteSpace({ spaceKey, }: {
+        /** The key of the space to delete. */
+        spaceKey: string;
+    }): Promise<LongTask>;
+    /**
+     * 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
+     */
+    getContentByTypeForSpace({ spaceKey, type, depth, expand, start, limit, }: {
+        /** The key of the space to be queried for its content. */
+        spaceKey: string;
+        /** The type of content to return. `page`, `blogpost`, `<some_customContentType>`. */
+        type: string;
+        /**
+         * Filter the results to content at the root level of the space or all
+         * content.
+         */
+        depth?: "all" | "root";
+        /**
+         * A multi-value parameter indicating which properties of the content to expand.
+         *
+         * - `childTypes.all` returns whether the content has attachments, comments, or
+         * child pages/whiteboards.
+         * Use this if you only need to check whether the content has children of a
+         * particular type.
+         * - `childTypes.attachment` returns whether the content has attachments.
+         * - `childTypes.comment` returns whether the content has comments.
+         * - `childTypes.page` returns whether the content has child pages.
+         * - `childTypes.whiteboard` returns whether the content has child whiteboards.
+         * - `childTypes.database` returns whether the content has child databases.
+         * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
+         * - `childTypes.folder` returns whether the content has child folders.
+         * - `container` returns the space that the content is in. This is the same as the
+         * information
+         * returned by [Get space](#api-space-spaceKey-get).
+         * - `metadata.currentuser` returns information about the current user in relation
+         * to the content,
+         * including when they last viewed it, modified it, contributed to it, or added it
+         * as a favorite.
+         * - `metadata.properties` returns content properties that have been set via the
+         * Confluence REST API.
+         * - `metadata.labels` returns the labels that have been added to the content.
+         * - `metadata.frontend` this property is only used by Atlassian.
+         * - `operations` returns the operations for the content, which are used when
+         * setting permissions.
+         * - `children.page` returns pages that are descendants at the level immediately
+         * below the content.
+         * - `children.whiteboard` returns whiteboards that are descendants at the level
+         * immediately below the content.
+         * - `children.database` returns databases that are descendants at the level
+         * immediately below the content.
+         * - `children.embed` returns embeds (smartlinks) that are descendants at the
+         * level immediately below the content.
+         * - `children.folder` returns folders that are descendants at the level
+         * immediately below the content.
+         * - `children.attachment` returns all attachments for the content.
+         * - `children.comment` returns all comments on the content.
+         * - `restrictions.read.restrictions.user` returns the users that have permission
+         * to read the content.
+         * - `restrictions.read.restrictions.group` returns the groups that have
+         * permission to read the content. Note that
+         * this may return deleted groups, because deleting a group doesn't remove
+         * associated restrictions.
+         * - `restrictions.update.restrictions.user` returns the users that have
+         * permission to update the content.
+         * - `restrictions.update.restrictions.group` returns the groups that have
+         * permission to update the content. Note that
+         * this may return deleted groups because deleting a group doesn't remove
+         * associated restrictions.
+         * - `history` returns the history of the content, including the date it was
+         * created.
+         * - `history.lastUpdated` returns information about the most recent update of the
+         * content, including
+         * who updated it and when it was updated.
+         * - `history.previousVersion` returns information about the update prior to the
+         * current content update.
+         * - `history.contributors` returns all of the users who have contributed to the
+         * content.
+         * - `history.nextVersion` returns information about the update after to the
+         * current content update.
+         * - `ancestors` returns the parent content, if the content is a page or
+         * whiteboard.
+         * - `body` returns the body of the content in different formats, including the
+         * editor format,
+         * view format, and export format.
+         * - `body.storage` returns the body of content in storage format.
+         * - `body.view` returns the body of content in view format.
+         * - `version` returns information about the most recent update of the content,
+         * including who updated it
+         * and when it was updated.
+         * - `descendants.page` returns pages that are descendants at any level below the
+         * content.
+         * - `descendants.whiteboard` returns whiteboards that are descendants at any
+         * level below the content.
+         * - `descendants.database` returns databases that are descendants at any level
+         * below the content.
+         * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
+         * level below the content.
+         * - `descendants.folder` returns folders that are descendants at any level below
+         * the content.
+         * - `descendants.attachment` returns all attachments for the content, same as
+         * `children.attachment`.
+         * - `descendants.comment` returns all comments on the content, same as
+         * `children.comment`.
+         * - `space` returns the space that the content is in. This is the same as the
+         * information returned by
+         * [Get space](#api-space-spaceKey-get).
+         *
+         * In addition, the following comment-specific expansions can be used:
+         * - `extensions.inlineProperties` returns inline comment-specific properties.
+         * - `extensions.resolution` returns the resolution status of each comment.
+         */
+        expand?: string[];
+        /** The starting index of the returned content. */
+        start?: number;
+        /**
+         * The maximum number of content objects to return per page. Note, this
+         * may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<ContentArray>;
+    /**
+     * 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
+     */
+    getContentForSpace({ spaceKey, depth, expand, start, limit, }: {
+        /** The key of the space to be queried for its content. */
+        spaceKey: string;
+        /** Filter the results to content at the root level of the space or all content. */
+        depth?: "all" | "root";
+        /**
+         * A multi-value parameter indicating which properties of the content to expand.
+         *
+         * - `childTypes.all` returns whether the content has attachments, comments, or
+         * child pages/whiteboards.
+         * Use this if you only need to check whether the content has children of a
+         * particular type.
+         * - `childTypes.attachment` returns whether the content has attachments.
+         * - `childTypes.comment` returns whether the content has comments.
+         * - `childTypes.page` returns whether the content has child pages.
+         * - `childTypes.whiteboard` returns whether the content has child whiteboards.
+         * - `childTypes.database` returns whether the content has child databases.
+         * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
+         * - `childTypes.folder` returns whether the content has child folders.
+         * - `container` returns the space that the content is in. This is the same as the
+         * information
+         * returned by [Get space](#api-space-spaceKey-get).
+         * - `metadata.currentuser` returns information about the current user in relation
+         * to the content,
+         * including when they last viewed it, modified it, contributed to it, or added it
+         * as a favorite.
+         * - `metadata.properties` returns content properties that have been set via the
+         * Confluence REST API.
+         * - `metadata.labels` returns the labels that have been added to the content.
+         * - `metadata.frontend` this property is only used by Atlassian.
+         * - `operations` returns the operations for the content, which are used when
+         * setting permissions.
+         * - `children.page` returns pages that are descendants at the level immediately
+         * below the content.
+         * - `children.whiteboard` returns whiteboards that are descendants at the level
+         * immediately below the content.
+         * - `children.database` returns databases that are descendants at the level
+         * immediately below the content.
+         * - `children.embed` returns embeds (smartlinks) that are descendants at the
+         * level immediately below the content.
+         * - `children.folder` returns folders that are descendants at the level
+         * immediately below the content.
+         * - `children.attachment` returns all attachments for the content.
+         * - `children.comment` returns all comments on the content.
+         * - `restrictions.read.restrictions.user` returns the users that have permission
+         * to read the content.
+         * - `restrictions.read.restrictions.group` returns the groups that have
+         * permission to read the content. Note that
+         * this may return deleted groups, because deleting a group doesn't remove
+         * associated restrictions.
+         * - `restrictions.update.restrictions.user` returns the users that have
+         * permission to update the content.
+         * - `restrictions.update.restrictions.group` returns the groups that have
+         * permission to update the content. Note that
+         * this may return deleted groups because deleting a group doesn't remove
+         * associated restrictions.
+         * - `history` returns the history of the content, including the date it was
+         * created.
+         * - `history.lastUpdated` returns information about the most recent update of the
+         * content, including
+         * who updated it and when it was updated.
+         * - `history.previousVersion` returns information about the update prior to the
+         * current content update.
+         * - `history.contributors` returns all of the users who have contributed to the
+         * content.
+         * - `history.nextVersion` returns information about the update after to the
+         * current content update.
+         * - `ancestors` returns the parent content, if the content is a page or
+         * whiteboard.
+         * - `body` returns the body of the content in different formats, including the
+         * editor format,
+         * view format, and export format.
+         * - `body.storage` returns the body of content in storage format.
+         * - `body.view` returns the body of content in view format.
+         * - `version` returns information about the most recent update of the content,
+         * including who updated it
+         * and when it was updated.
+         * - `descendants.page` returns pages that are descendants at any level below the
+         * content.
+         * - `descendants.whiteboard` returns whiteboards that are descendants at any
+         * level below the content.
+         * - `descendants.database` returns databases that are descendants at any level
+         * below the content.
+         * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
+         * level below the content.
+         * - `descendants.folder` returns folders that are descendants at any level below
+         * the content.
+         * - `descendants.attachment` returns all attachments for the content, same as
+         * `children.attachment`.
+         * - `descendants.comment` returns all comments on the content, same as
+         * `children.comment`.
+         * - `space` returns the space that the content is in. This is the same as the
+         * information returned by
+         * [Get space](#api-space-spaceKey-get).
+         *
+         * In addition, the following comment-specific expansions can be used:
+         * - `extensions.inlineProperties` returns inline comment-specific properties.
+         * - `extensions.resolution` returns the resolution status of each comment.
+         */
+        expand?: string[];
+        /** The starting index of the returned content. */
+        start?: number;
+        /**
+         * The maximum number of content objects to return per page. Note, this
+         * may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<{
+        page?: ContentArray;
+        blogpost?: ContentArray;
+        _links?: GenericLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * 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
+     */
+    getSpace({ spaceKey, expand, }: {
+        /** The key of the space to be returned. */
+        spaceKey: string;
+        /**
+         * A multi-value parameter indicating which properties of the spaces to
+         * expand, where:
+         *
+         *   - `settings` returns the settings for the space, similar to [Get space
+         * settings](#api-space-spaceKey-settings-get).
+         *   - `metadata` returns the space metadata.
+         *   - `metadata.labels` returns the space labels, which are used to categorize
+         * the space.
+         *   - `operations` returns the operations for a space, which are used when
+         * setting permissions.
+         *   - `lookAndFeel` returns information about the look and feel of the space,
+         * including the color scheme.
+         *   - `permissions` returns the permissions for the space. Note that this may
+         * return permissions for deleted groups,
+         *   because deleting a group doesn't remove associated space permissions.
+         *   - `icon` returns information about space icon.
+         *   - `description` returns the description of the space.
+         *   - `description.plain` returns the description of the space, the plain format.
+         *   - `description.view` returns the description of the space, the view format.
+         *   - `theme` returns information about the space theme.
+         *   - `homepage` returns information about the space homepage.
+         *   - `history` returns information about the history of the space.
+         */
+        expand?: ("settings" | "metadata" | "metadata.labels" | "operations" | "lookAndFeel" | "permissions" | "icon" | "description" | "description.plain" | "description.view" | "theme" | "homepage" | "history")[];
+    }): Promise<Space | null>;
+    /**
+     * 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
+     */
+    getSpaces({ spaceKey, spaceId, type, status, label, favourite, favouriteUserKey, expand, start, limit, }: {
+        /**
+         * The key of the space to be returned. To return multiple spaces,
+         * specify this parameter multiple times with different values.
+         */
+        spaceKey?: string[];
+        /**
+         * The id of the space to be returned. To return multiple spaces,
+         * specify this parameter multiple times with different values.
+         */
+        spaceId?: number[];
+        /** Filter the results to spaces based on their type. */
+        type?: "global" | "collaboration" | "knowledge_base" | "personal";
+        /** Filter the results to spaces based on their status. */
+        status?: "current" | "archived";
+        /** Filter the results to spaces based on their label. */
+        label?: string[];
+        /**
+         * Filter the results to the favourite spaces of the user specified by
+         * `favouriteUserKey`. Note, 'favourite' spaces are also
+         * known as 'saved for later' spaces.
+         */
+        favourite?: boolean;
+        /**
+         * The userKey of the user, whose favourite spaces are used to filter
+         * the results when using the `favourite` parameter.
+         *
+         * Leave blank for the current user. Use [Get user](#api-user-get) to
+         * get the userKey for a user.
+         */
+        favouriteUserKey?: string;
+        /**
+         * A multi-value parameter indicating which properties of the spaces to
+         * expand, where:
+         *
+         *   - `settings` returns the settings for the space, similar to [Get space
+         * settings](#api-space-spaceKey-settings-get).
+         *   - `metadata` returns the space metadata.
+         *   - `metadata.labels` returns the space labels, which are used to categorize
+         * the space.
+         *   - `operations` returns the operations for a space, which are used when
+         * setting permissions.
+         *   - `lookAndFeel` returns information about the look and feel of the space,
+         * including the color scheme.
+         *   - `permissions` returns the permissions for the space. Note that this may
+         * return permissions for deleted groups,
+         *   because deleting a group doesn't remove associated space permissions.
+         *   - `icon` returns information about space icon.
+         *   - `description` returns the description of the space.
+         *   - `description.plain` returns the description of the space, the plain format.
+         *   - `description.view` returns the description of the space, the view format.
+         *   - `theme` returns information about the space theme.
+         *   - `homepage` returns information about the space homepage.
+         *   - `history` returns information about the history of the space.
+         */
+        expand?: ("settings" | "metadata" | "metadata.labels" | "operations" | "lookAndFeel" | "permissions" | "icon" | "description" | "description.plain" | "description.view" | "theme" | "homepage" | "history")[];
+        /** The starting index of the returned spaces. */
+        start?: number;
+        /**
+         * The maximum number of spaces to return per page. Note, this may be
+         * restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<SpaceArray>;
+    /**
+     * 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
+     */
+    updateSpace({ spaceKey, spaceUpdate, }: {
+        /** The key of the space to update. */
+        spaceKey: string;
+        /** The updated space. */
+        spaceUpdate: SpaceUpdate;
+    }): Promise<Space | null>;
+    static initialize(): void;
+}