@resolution/confluence-api-client 0.13.4 → 0.14.0

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

@@ -0,0 +1,346 @@
+import { CommonHttpService } from "../../core/CommonHttpService";
+import { type MultiEntityLinks } from "../models/common";
+import { type DescendantsResponse } from "../models/descendants";
+/**
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants
+ * @category Services
+ */
+export declare class DescendantsService extends CommonHttpService {
+    /**
+     * Returns descendants in the content tree for a given database by ID in
+     * top-to-bottom order (that is, the highest descendant is the first
+     * item in the response payload). The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available by calling this endpoint with the cursor in the response
+     * payload. There is also a `depth` parameter specifying depth
+     * of descendants to be fetched.
+     *
+     * The following types of content will be returned:
+     * - Database
+     * - Embed
+     * - Folder
+     * - Page
+     * - Whiteboard
+     *
+     * This endpoint returns minimal information about each descendant. To fetch more
+     * details, use a related endpoint based on the content type, such
+     * as:
+     *
+     * - [Get database by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
+     * - [Get embed by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
+     * - [Get folder by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
+     * - [Get page by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
+     * - [Get whiteboard by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Permission to view the database and its corresponding space
+     *
+     * @returns Returned if the requested descendants are returned.
+     * @path GET `/databases/{id}/descendants`
+     * @scopes-current read:hierarchical-content:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-databases-id-descendants-get
+     * @param params
+     */
+    getDatabaseDescendants: ({ id, limit, depth, cursor }: {
+        /** The ID of the database. */
+        id: number;
+        /**
+         * Maximum number of items per result to return. If more results exist, call the
+         * endpoint with the cursor to fetch the next set of results.
+         */
+        limit?: number | undefined;
+        /**
+         * Maximum depth of descendants to return. If more results are required, use the
+         * endpoint corresponding to the content type of the deepest descendant to fetch
+         * more descendants.
+         */
+        depth?: number | undefined;
+        /**
+         * 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 | undefined;
+    }) => Promise<{
+        results?: DescendantsResponse[] | undefined;
+        _links?: MultiEntityLinks | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns descendants in the content tree for a given folder by ID in
+     * top-to-bottom order (that is, the highest descendant is the first
+     * item in the response payload). The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available by calling this endpoint with the cursor in the response
+     * payload. There is also a `depth` parameter specifying depth
+     * of descendants to be fetched.
+     *
+     * The following types of content will be returned:
+     * - Database
+     * - Embed
+     * - Folder
+     * - Page
+     * - Whiteboard
+     *
+     * This endpoint returns minimal information about each descendant. To fetch more
+     * details, use a related endpoint based on the content type, such
+     * as:
+     *
+     * - [Get database by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
+     * - [Get embed by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
+     * - [Get folder by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
+     * - [Get page by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
+     * - [Get whiteboard by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Permission to view the  and its corresponding space
+     *
+     * @returns Returned if the requested descendants are returned.
+     * @path GET `/folders/{id}/descendants`
+     * @scopes-current read:hierarchical-content:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-folders-id-descendants-get
+     * @param params
+     */
+    getFolderDescendants: ({ id, limit, depth, cursor }: {
+        /** The ID of the folder. */
+        id: number;
+        /**
+         * Maximum number of items per result to return. If more results exist, call the
+         * endpoint with the cursor to fetch the next set of results.
+         */
+        limit?: number | undefined;
+        /**
+         * Maximum depth of descendants to return. If more results are required, use the
+         * endpoint corresponding to the content type of the deepest descendant to fetch
+         * more descendants.
+         */
+        depth?: number | undefined;
+        /**
+         * 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 | undefined;
+    }) => Promise<{
+        results?: DescendantsResponse[] | undefined;
+        _links?: MultiEntityLinks | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns descendants in the content tree for a given page by ID in top-to-bottom
+     * order (that is, the highest descendant is the first
+     * item in the response payload). The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available by calling this endpoint with the cursor in the response
+     * payload. There is also a `depth` parameter specifying depth
+     * of descendants to be fetched.
+     *
+     * The following types of content will be returned:
+     * - Database
+     * - Embed
+     * - Folder
+     * - Page
+     * - Whiteboard
+     *
+     * This endpoint returns minimal information about each descendant. To fetch more
+     * details, use a related endpoint based on the content type, such
+     * as:
+     *
+     * - [Get database by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
+     * - [Get embed by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
+     * - [Get folder by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
+     * - [Get page by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
+     * - [Get whiteboard by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Permission to view the page and its corresponding space
+     *
+     * @returns Returned if the requested descendants are returned.
+     * @path GET `/pages/{id}/descendants`
+     * @scopes-current read:hierarchical-content:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-pages-id-descendants-get
+     * @param params
+     */
+    getPageDescendants: ({ id, limit, depth, cursor }: {
+        /** The ID of the page. */
+        id: number;
+        /**
+         * Maximum number of items per result to return. If more results exist, call the
+         * endpoint with the cursor to fetch the next set of results.
+         */
+        limit?: number | undefined;
+        /**
+         * Maximum depth of descendants to return. If more results are required, use the
+         * endpoint corresponding to the content type of the deepest descendant to fetch
+         * more descendants.
+         */
+        depth?: number | undefined;
+        /**
+         * 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 | undefined;
+    }) => Promise<{
+        results?: DescendantsResponse[] | undefined;
+        _links?: MultiEntityLinks | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns descendants in the content tree for a given smart link by ID in
+     * top-to-bottom order (that is, the highest descendant is the first
+     * item in the response payload). The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available by calling this endpoint with the cursor in the response
+     * payload. There is also a `depth` parameter specifying depth
+     * of descendants to be fetched.
+     *
+     * The following types of content will be returned:
+     * - Database
+     * - Embed
+     * - Folder
+     * - Page
+     * - Whiteboard
+     *
+     *
+     * This endpoint returns minimal information about each descendant. To fetch more
+     * details, use a related endpoint based on the content type, such
+     * as:
+     *
+     * - [Get database by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
+     * - [Get embed by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
+     * - [Get folder by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
+     * - [Get page by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
+     * - [Get whiteboard by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Permission to view the smart link and its corresponding space
+     *
+     * @returns Returned if the requested descendants are returned.
+     * @path GET `/embeds/{id}/descendants`
+     * @scopes-current read:hierarchical-content:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-embeds-id-descendants-get
+     * @param params
+     */
+    getSmartLinkDescendants: ({ id, limit, depth, cursor }: {
+        /** The ID of the smart link. */
+        id: number;
+        /**
+         * Maximum number of items per result to return. If more results exist, call the
+         * endpoint with the cursor to fetch the next set of results.
+         */
+        limit?: number | undefined;
+        /**
+         * Maximum depth of descendants to return. If more results are required, use the
+         * endpoint corresponding to the content type of the deepest descendant to fetch
+         * more descendants.
+         */
+        depth?: number | undefined;
+        /**
+         * 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 | undefined;
+    }) => Promise<{
+        results?: DescendantsResponse[] | undefined;
+        _links?: MultiEntityLinks | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns descendants in the content tree for a given whiteboard by ID in
+     * top-to-bottom order (that is, the highest descendant is the first
+     * item in the response payload). The number of results is limited by the `limit`
+     * parameter and additional results (if available)
+     * will be available by calling this endpoint with the cursor in the response
+     * payload. There is also a `depth` parameter specifying depth
+     * of descendants to be fetched.
+     *
+     * The following types of content will be returned:
+     * - Database
+     * - Embed
+     * - Folder
+     * - Page
+     * - Whiteboard
+     *
+     * This endpoint returns minimal information about each descendant. To fetch more
+     * details, use a related endpoint based on the content type, such
+     * as:
+     *
+     * - [Get database by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
+     * - [Get embed by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
+     * - [Get folder by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
+     * - [Get page by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
+     * - [Get whiteboard by
+     * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * Permission to view the whiteboard and its corresponding space
+     *
+     * @returns Returned if the requested descendants are returned.
+     * @path GET `/whiteboards/{id}/descendants`
+     * @scopes-current read:hierarchical-content:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-whiteboards-id-descendants-get
+     * @param params
+     */
+    getWhiteboardDescendants: ({ id, limit, depth, cursor }: {
+        /** The ID of the whiteboard. */
+        id: number;
+        /**
+         * Maximum number of items per result to return. If more results exist, call the
+         * endpoint with the cursor to fetch the next set of results.
+         */
+        limit?: number | undefined;
+        /**
+         * Maximum depth of descendants to return. If more results are required, use the
+         * endpoint corresponding to the content type of the deepest descendant to fetch
+         * more descendants.
+         */
+        depth?: number | undefined;
+        /**
+         * 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 | undefined;
+    }) => Promise<{
+        results?: DescendantsResponse[] | undefined;
+        _links?: MultiEntityLinks | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    protected static initialize(): void;
+}