@resolution/confluence-api-client 0.2.0

package/lib/openapi/v2/services/PageService.d.ts

@@ -0,0 +1,408 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type MultiEntityLinks, type PrimaryBodyRepresentation, type PrimaryBodyRepresentationSingle } from "../models/common";
+import { type PageBodyWrite, type PageBulk, type PageNestedBodyWrite, type PageSingle, type PageSortOrder } from "../models/page";
+export declare class PageService extends CommonHttpService {
+    /**
+     * Creates a page in the space.
+     *
+     * Pages are created as published by default unless specified as a draft in the
+     * status field. If creating a published page, the title must be specified.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the corresponding space. Permission to create a page in the
+     * space.
+     *
+     * @returns Returned if the page was successfully created.
+     * @path {POST} /pages
+     * @scopes-current write:page:confluence
+     */
+    createPage({ embedded, private: privateQuery, rootLevel, requestBody, }: {
+        /** Tag the content as embedded and content will be created in NCS. */
+        embedded?: boolean;
+        /**
+         * The page will be private. Only the user who creates this page will have
+         * permission to view and edit one.
+         */
+        private?: boolean;
+        /**
+         * The page will be created at the root level of the space (outside the space
+         * homepage tree).
+         */
+        rootLevel?: boolean;
+        requestBody: {
+            /** ID of the space. */
+            spaceId: string;
+            /** The status of the page, published or draft. */
+            status?: "current" | "draft";
+            /** Title of the page, required if page status is not draft. */
+            title?: string;
+            /** The parent content ID of the page. */
+            parentId?: string;
+            body?: PageBodyWrite | PageNestedBodyWrite;
+        } & {
+            [key: string]: unknown;
+        };
+    }): Promise<PageSingle & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Delete a page by id.
+     *
+     * By default this will delete pages that are non-drafts. To delete a page that is
+     * a draft, the endpoint must be called on a
+     * draft with the following param `draft=true`. Discarded drafts are not sent to
+     * the trash and are permanently deleted.
+     *
+     * Deleting a page moves the page to the trash, where it can be restored later. To
+     * permanently delete a page (or "purge" it),
+     * the endpoint must be called on a **trashed** page with the following param
+     * `purge=true`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page and its corresponding space.
+     * Permission to delete pages in the space.
+     * Permission to administer the space (if attempting to purge).
+     *
+     * @path {DELETE} /pages/{id}
+     * @scopes-current delete:page:confluence
+     */
+    deletePage({ id, purge, draft, }: {
+        /** The ID of the page to be deleted. */
+        id: number;
+        /** If attempting to purge the page. */
+        purge?: boolean;
+        /** If attempting to delete a page that is a draft. */
+        draft?: boolean;
+    }): Promise<void>;
+    /**
+     * Returns the pages of specified label. The number of results is limited by the
+     * `limit` parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page and its corresponding space.
+     *
+     * @returns Returned if the requested pages for specified label were successfully fetched.
+     * @path {GET} /labels/{id}/pages
+     * @scopes-current read:page:confluence
+     */
+    getLabelPages({ id, spaceId, bodyFormat, sort, cursor, limit, }: {
+        /** The ID of the label for which pages should be returned. */
+        id: number;
+        /**
+         * Filter the results based on space ids. Multiple space ids can be specified as a
+         * comma-separated list.
+         */
+        spaceId?: number[];
+        /**
+         * The content format types to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /** Used to sort the result by a particular field. */
+        sort?: PageSortOrder;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of pages per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: PageBulk[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns a specific page.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page and its corresponding space.
+     *
+     * @returns Returned if the requested page is returned.
+     * @path {GET} /pages/{id}
+     * @scopes-current read:page:confluence
+     */
+    getPageById({ id, bodyFormat, getDraft, version, includeLabels, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, includeFavoritedByCurrentUserStatus, }: {
+        /**
+         * The ID of the page to be returned. If you don't know the page ID, use Get pages
+         * and filter the results.
+         */
+        id: number;
+        /**
+         * The content format types to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentationSingle;
+        /** Retrieve the draft version of this page. */
+        getDraft?: boolean;
+        /**
+         * Allows you to retrieve a previously published version. Specify the previous
+         * version's number to retrieve its details.
+         */
+        version?: number;
+        /**
+         * Includes labels associated with this page in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeLabels?: boolean;
+        /**
+         * Includes content properties associated with this page in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeProperties?: boolean;
+        /**
+         * Includes operations associated with this page in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeOperations?: boolean;
+        /**
+         * Includes likes associated with this page in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeLikes?: boolean;
+        /**
+         * Includes versions associated with this page in the response.
+         * The number of results will be limited to 50 and sorted in the default sort
+         * order.
+         * A `meta` and `_links` property will be present to indicate if more results are
+         * available and a link to retrieve the rest of the results.
+         */
+        includeVersions?: boolean;
+        /**
+         * Includes the current version associated with this page in the response.
+         * By default this is included and can be omitted by setting the value to `false`.
+         */
+        includeVersion?: boolean;
+        /** Includes whether this page has been favorited by the current user. */
+        includeFavoritedByCurrentUserStatus?: boolean;
+    }): Promise<PageSingle & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Returns all pages. The number of results is limited by the `limit` parameter
+     * and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Only pages that the user has permission to view will be returned.
+     *
+     * @returns Returned if the requested pages are returned.
+     * @path {GET} /pages
+     * @scopes-current read:page:confluence
+     */
+    getPages({ id, spaceId, sort, status, title, bodyFormat, cursor, limit, }: {
+        /**
+         * Filter the results based on page ids. Multiple page ids can be specified as a
+         * comma-separated list.
+         */
+        id?: number[];
+        /**
+         * Filter the results based on space ids. Multiple space ids can be specified as a
+         * comma-separated list.
+         */
+        spaceId?: number[];
+        /** Used to sort the result by a particular field. */
+        sort?: PageSortOrder;
+        /**
+         * Filter the results to pages based on their status. By default, `current` and
+         * `archived` are used.
+         */
+        status?: ("current" | "archived" | "deleted" | "trashed")[];
+        /** Filter the results to pages based on their title. */
+        title?: string;
+        /**
+         * The content format types to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of pages per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: PageBulk[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns all pages in a space. The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available through the `next` URL present in the `Link` response header.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission) and
+     * 'View' permission for the space.
+     * Only pages that the user has permission to view will be returned.
+     *
+     * @returns Returned if the requested pages are returned.
+     * @path {GET} /spaces/{id}/pages
+     * @scopes-current read:page:confluence
+     */
+    getPagesInSpace({ id, depth, sort, status, title, bodyFormat, cursor, limit, }: {
+        /** The ID of the space for which pages should be returned. */
+        id: number;
+        /**
+         * Filter the results to pages at the root level of the space or to all pages in
+         * the space.
+         */
+        depth?: "all" | "root";
+        /** Used to sort the result by a particular field. */
+        sort?: PageSortOrder;
+        /**
+         * Filter the results to pages based on their status. By default, `current` and
+         * `archived` are used.
+         */
+        status?: ("current" | "archived" | "deleted" | "trashed")[];
+        /** Filter the results to pages based on their title. */
+        title?: string;
+        /**
+         * The content format types to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of pages per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: PageBulk[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Update a page by id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page and its corresponding space. Permission to update
+     * pages in the space.
+     *
+     * @returns Returned if the requested page is successfully updated.
+     * @path {PUT} /pages/{id}
+     * @scopes-current write:page:confluence
+     */
+    updatePage({ id, requestBody, }: {
+        /**
+         * The ID of the page to be updated. If you don't know the page ID, use Get Pages
+         * and filter the results.
+         */
+        id: number;
+        requestBody: {
+            /** Id of the page. */
+            id: string;
+            /**
+             * The updated status of the page.
+             *
+             * Note, if you change the status of a page from 'current' to 'draft' and it has
+             * an existing draft, the existing draft will be deleted in favor of the updated
+             * draft.
+             * Additionally, this endpoint can be used to restore a 'trashed' or 'deleted'
+             * page to 'current' status. For restoration, page contents will not be updated
+             * and only the page status will be changed.
+             */
+            status: "current" | "draft";
+            /** Title of the page. */
+            title: string;
+            /**
+             * ID of the containing space.
+             *
+             * This currently **does not support moving the page to a different space**.
+             */
+            spaceId?: unknown;
+            /**
+             * ID of the parent page.
+             *
+             * This allows the page to be moved under a different parent within the same space.
+             */
+            parentId?: unknown;
+            /**
+             * Account ID of the page owner.
+             *
+             * This allows page ownership to be transferred to another user.
+             */
+            ownerId?: unknown;
+            body: PageBodyWrite | PageNestedBodyWrite;
+            version: {
+                /**
+                 * The new version of the updated page.
+                 * Set this to the current version number plus one, unless you are updating the
+                 * status to 'draft' which requires a version number of 1.
+                 *
+                 * If you don't know the current version number, use Get page by id.
+                 */
+                number?: number;
+                /** An optional message to be stored with the version. */
+                message?: string;
+            } & {
+                [key: string]: unknown;
+            };
+        } & {
+            [key: string]: unknown;
+        };
+    }): Promise<PageSingle & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    static initialize(): void;
+}