@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,1012 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type Content, type ContentArray, type LongTask } from "../models/common";
+import { type ContentBlueprintDraft, type ContentCreate, type ContentHistory, type ContentUpdate } from "../models/content";
+export declare class ContentService extends CommonHttpService {
+    /**
+     * Archives a list of pages. The pages to be archived are specified as a list of
+     * content IDs.
+     * This API accepts the archival request and returns a task ID.
+     * The archival process happens asynchronously.
+     * Use the /longtask/<taskId> REST API to get the copy task status.
+     *
+     * Each content ID needs to resolve to page objects that are not already in an
+     * archived state.
+     * The content IDs need not belong to the same space.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Archive' permission for each of the pages in the corresponding space it
+     * belongs to.
+     *
+     * @returns Returned if the archive request has been submitted.
+     * @path {POST} /wiki/rest/api/content/archive
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content.metadata:confluence, write:page:confluence
+     */
+    archivePages({ requestBody, }: {
+        /** The pages to be archived. */
+        requestBody: {
+            pages?: ({
+                /** The `id` of the page to be archived. */
+                id: number;
+            } & {
+                [key: string]: unknown;
+            })[];
+        } & {
+            [key: string]: unknown;
+        };
+    }): Promise<LongTask>;
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Creates a new piece of content or publishes an existing draft.
+     *
+     * To publish a draft, add the `id` and `status` properties to the body of the
+     * request.
+     * Set the `id` to the ID of the draft and set the `status` to 'current'. When the
+     * request is sent, a new piece of content will be created and the metadata from
+     * the
+     * draft will be transferred into it.
+     *
+     * By default, the following objects are expanded: `space`, `history`, `version`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Add'
+     * permission for the
+     * space that the content will be created in, and permission to view the draft if
+     * publishing a draft.
+     *
+     * @deprecated
+     * @returns Returned if the content is created.
+     * @path {POST} /wiki/rest/api/content
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:content:confluence
+     */
+    createContent({ status, expand, contentCreate, }: {
+        /** Filter the returned content by status. */
+        status?: string;
+        /**
+         * A multi-value parameter indicating which properties of the content to expand.
+         * Maximum sub-expansions allowed is `8`.
+         *
+         * - `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 folder.
+         * - `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 new content to be created. Set the `representation` to the name of the body
+         * format type. For example, if you use `storage` for the body format, set
+         * '`representation`=`storage`'. See
+         * [Confluence storage format](https://confluence.atlassian.com/x/AJkiLw).
+         *
+         * If you are not sure how to generate the different formats, you can create a
+         * page in the
+         * Confluence application, retrieve the content using [Get
+         * content](#api-content-get),
+         * and expand the desired content format, e.g. `expand=body.storage`.
+         */
+        contentCreate: ContentCreate | null;
+    }): Promise<Content | null>;
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Moves a piece of content to the space's trash or purges it from the trash,
+     * depending on the content's type and status:
+     *
+     * - If the content's type is `page`,`blogpost`, or `attachment` and its status is
+     * `current`,
+     * it will be trashed.
+     * - If the content's type is `page`,`blogpost`, or `attachment` and its status is
+     * `trashed`,
+     * the content will be purged from the trash and deleted permanently. Note,
+     * you must also set the `status` query parameter to `trashed` in your request.
+     * - If the content's type is `comment`, it will be deleted
+     * permanently without being trashed.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Delete' permission for the space that the content is in.
+     *
+     * @deprecated
+     * @path {DELETE} /wiki/rest/api/content/{id}
+     * @scopes-current write:confluence-content
+     * @scopes-beta delete:content:confluence
+     */
+    deleteContent({ id, status, }: {
+        /** The ID of the content to be deleted. */
+        id: string;
+        /**
+         * Set this to `trashed`, if the content's status is `trashed` and you want to
+         * purge it.
+         */
+        status?: string;
+    }): Promise<void>;
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns all content in a Confluence instance.
+     *
+     * By default, the following objects are expanded: `space`, `history`, `version`.
+     *
+     * 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**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Only content that the user has permission to view will be returned.
+     *
+     * @deprecated
+     * @returns Returned if the requested list of content is returned.
+     * @path {GET} /wiki/rest/api/content
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContent({ type, spaceKey, title, status, postingDay, expand, trigger, orderby, start, limit, }: {
+        /**
+         * The type of content to return. For example:
+         *   - page
+         *   - blogpost
+         */
+        type?: string;
+        /** The key of the space to be queried for its content. */
+        spaceKey?: string;
+        /** The title of the page to be returned. Required for <code>page</code> type. */
+        title?: string;
+        /**
+         * Filter the results to a set of content based on their status. If set to `any`,
+         * content with any status is returned. Note, the `historical` status is currently
+         * not supported.
+         */
+        status?: "current" | "trashed" | "deleted" | "historical" | "draft" | "any";
+        /**
+         * The posting date of the blog post to be returned. Required for
+         * <code>blogpost</code> type. Format: <code>yyyy-mm-dd</code>.
+         */
+        postingDay?: string;
+        /**
+         * A multi-value parameter indicating which properties of the content to expand.
+         * Maximum sub-expansions allowed is `8`.
+         *
+         * - `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 folder.
+         * - `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[];
+        /**
+         * If set to `viewed`, the request will trigger a 'viewed' event for the content.
+         * When this event is triggered, the page/blogpost will appear on the 'Recently
+         * visited'
+         * tab of the user's Confluence dashboard.
+         */
+        trigger?: "viewed";
+        /**
+         * Orders the content by a particular field. Specify the field and sort direction
+         * for
+         * this parameter, as follows: 'fieldpath asc/desc'. For example,
+         * 'history.createdDate desc'.
+         */
+        orderby?: 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 a single piece of content, like a page or a blog post.
+     *
+     * By default, the following objects are expanded: `space`, `history`, `version`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content. If the content is a blog post, 'View' permission
+     * for the space is required.
+     *
+     * @deprecated
+     * @returns Returned if the requested content is returned.
+     * @path {GET} /wiki/rest/api/content/{id}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentById({ id, status, version, embeddedContentRender, expand, trigger, }: {
+        /**
+         * The ID of the content to be returned. If you don't know the content ID,
+         * use [Get content](#api-content-get) and filter the results.
+         */
+        id: string;
+        /**
+         * Filter the results to a set of content based on their status.
+         * If set to `any`, content with any status is returned. Note, the
+         * `historical` status is currently not supported.
+         */
+        status?: "current" | "trashed" | "deleted" | "historical" | "draft" | "any";
+        /** The version number of the content to be returned. */
+        version?: number;
+        /**
+         * The version of embedded content (e.g. attachments) to render.
+         *
+         * - <code>current</code> renders the latest version of the embedded content.
+         * - <code>version-at-save</code> renders the version of the embedded content
+         * at the time of save.
+         */
+        embeddedContentRender?: "current" | "version-at-save";
+        /**
+         * A multi-value parameter indicating which properties of the content to expand.
+         * Maximum sub-expansions allowed is `8`.
+         *
+         * - `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 folder.
+         * - `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[];
+        /**
+         * If set to `viewed`, the request will trigger a 'viewed' event for the content.
+         * When this event is triggered, the page/blogpost will appear on the 'Recently
+         * visited'
+         * tab of the user's Confluence dashboard.
+         */
+        trigger?: "viewed";
+    }): Promise<Content | null>;
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns the most recent update for a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content.
+     *
+     * @deprecated
+     * @returns Returned if the requested content history is returned.
+     * @path {GET} /wiki/rest/api/content/{id}/history
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content.metadata:confluence, read:user:confluence
+     */
+    getHistoryForContent({ id, expand, }: {
+        /** The ID of the content to be queried for its history. */
+        id: string;
+        /**
+         * A multi-value parameter indicating which properties of the content history to
+         * expand.
+         * Maximum sub-expansions allowed is `8`.
+         *
+         * - `lastUpdated` returns information about the most recent update of the content,
+         * including who updated it and when it was updated.
+         * - `previousVersion` returns information about the update prior to the current
+         * content
+         * update. For this method, it contains the same information as `lastUpdated`.
+         * - `contributors` returns all of the users who have contributed to the content.
+         * - `nextVersion` This parameter is not used for this method.
+         */
+        expand?: ("lastUpdated" | "previousVersion" | "contributors" | "nextVersion")[];
+    }): Promise<ContentHistory | null>;
+    /**
+     * Publishes a legacy draft of a page created from a blueprint. Legacy drafts
+     * will eventually be removed in favor of shared drafts. For now, this method
+     * works the same as [Publish shared
+     * draft](#api-content-blueprint-instance-draftId-put).
+     *
+     * By default, the following objects are expanded: `body.storage`, `history`,
+     * `space`, `version`, `ancestors`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the draft and 'Add' permission for the space that
+     * the content will be created in.
+     *
+     * @returns Returned if the draft was successfully published.
+     * @path {POST} /wiki/rest/api/content/blueprint/instance/{draftId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:content:confluence
+     */
+    publishLegacyDraft({ draftId, status, expand, contentBlueprintDraft, }: {
+        /**
+         * The ID of the draft page that was created from a blueprint.
+         * You can find the `draftId` in the Confluence application by
+         * opening the draft page and checking the page URL.
+         */
+        draftId: string;
+        /**
+         * The status of the content to be updated, i.e. the draft. This is set
+         * to 'draft' by default, so you shouldn't need to specify it.
+         */
+        status?: string;
+        /**
+         * 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[];
+        contentBlueprintDraft: ContentBlueprintDraft;
+    }): Promise<Content | null>;
+    /**
+     * Publishes a shared draft of a page created from a blueprint.
+     *
+     * By default, the following objects are expanded: `body.storage`, `history`,
+     * `space`, `version`, `ancestors`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the draft and 'Add' permission for the space that
+     * the content will be created in.
+     *
+     * @returns Returned if the draft was successfully published.
+     * @path {PUT} /wiki/rest/api/content/blueprint/instance/{draftId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:content:confluence
+     */
+    publishSharedDraft({ draftId, status, expand, contentBlueprintDraft, }: {
+        /**
+         * The ID of the draft page that was created from a blueprint.
+         * You can find the `draftId` in the Confluence application by
+         * opening the draft page and checking the page URL.
+         */
+        draftId: string;
+        /**
+         * The status of the content to be updated, i.e. the draft. This is set
+         * to 'draft' by default, so you shouldn't need to specify it.
+         */
+        status?: string;
+        /**
+         * 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[];
+        contentBlueprintDraft: ContentBlueprintDraft;
+    }): Promise<Content | null>;
+    /**
+     * Returns the list of content that matches a Confluence Query Language
+     * (CQL) query. For information on CQL, see:
+     * [Advanced searching using
+     * CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
+     *
+     * Example initial call:
+     * ```
+     * /wiki/rest/api/content/search?cql=type=page&limit=25
+     * ```
+     *
+     * Example response:
+     * ```
+     * {
+     *   "results": [
+     *     { ... },
+     *     { ... },
+     *     ...
+     *     { ... }
+     *   ],
+     *   "limit": 25,
+     *   "size": 25,
+     *   ...
+     *   "_links": {
+     *     "base": "<url>",
+     *     "context": "<url>",
+     *     "next":
+     * "/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
+     *     "self": "<url>"
+     *   }
+     * }
+     * ```
+     *
+     * When additional results are available, returns `next` and `prev` URLs to
+     * retrieve them in subsequent calls. The URLs each contain a cursor that points
+     * to the appropriate set of results. Use `limit` to specify the number of results
+     * returned in each call.
+     * Example subsequent call (taken from example response):
+     * ```
+     * /wiki/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
+     * ```
+     * The response to this will have a `prev` URL similar to the `next` in the
+     * example response.
+     *
+     * 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**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Only content that the user has permission to view will be returned.
+     *
+     * @returns Returned if the requested list of content is returned.
+     * @path {GET} /wiki/rest/api/content/search
+     * @scopes-current search:confluence
+     * @scopes-beta read:content-details:confluence
+     */
+    searchContentByCql({ cql, cqlcontext, expand, cursor, limit, }: {
+        /** The CQL string that is used to find the requested content. */
+        cql: string;
+        /**
+         * The space, content, and content status to execute the search against.
+         * Specify this as an object with the following properties:
+         *
+         * - `spaceKey` Key of the space to search against. Optional.
+         * - `contentId` ID of the content to search against. Optional. Must
+         * be in the space spacified by `spaceKey`.
+         * - `contentStatuses` Content statuses to search against. Optional.
+         */
+        cqlcontext?: string;
+        /**
+         * 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[];
+        /**
+         * Pointer to a set of search results, returned as part of the `next` or `prev`
+         * URL from the previous search call.
+         */
+        cursor?: string;
+        /**
+         * 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/).
+     *
+     * Updates a piece of content. Use this method to update the title or body
+     * of a piece of content, change the status, change the parent page, and more.
+     *
+     * Note, updating draft content is currently not supported.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @deprecated
+     * @returns Returned if the content is updated.
+     * @path {PUT} /wiki/rest/api/content/{id}
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:content:confluence
+     */
+    updateContent({ id, status, conflictPolicy, contentUpdate, }: {
+        /** The ID of the content to be updated. */
+        id: string;
+        /**
+         * The updated status of the content. Use this parameter to change the
+         * status of a piece of content without passing the entire request body.
+         */
+        status?: "current" | "trashed" | "deleted" | "historical" | "draft";
+        /**
+         * The action that should be taken when conflicts are discovered.
+         * Only used when publishing a draft page.
+         */
+        conflictPolicy?: "abort";
+        /** The updated content. */
+        contentUpdate: ContentUpdate;
+    }): Promise<Content | null>;
+    static initialize(): void;
+}