@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,453 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentChildrenAndDescendantsService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/CommonHttpClient");
+const CommonHttpService_1 = require("../core/CommonHttpService");
+const common_1 = require("../models/common");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class ContentChildrenAndDescendantsService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Copies a single page and its associated properties, permissions, attachments,
+     * and custom contents.
+     *  The `id` path parameter refers to the content ID of the page to copy. The
+     * target of the page to be copied
+     *  is defined using the `destination` in the request body and can be one of the
+     * following types.
+     *
+     *   - `space`: page will be copied to the specified space as a root page on the
+     * space
+     *   - `parent_page`: page will be copied as a child of the specified parent page
+     *   - `existing_page`: page will be copied and replace the specified page
+     *
+     * 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 copied in and permission to
+     * update the content if copying to an `existing_page`.
+     *
+     * @returns Returned if the content is copied.
+     * @path {POST} /wiki/rest/api/content/{id}/copy
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:page:confluence
+     */
+    copyPage({ id, expand, copyPageRequest, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/copy",
+            method: "POST",
+            pathParams: {
+                id,
+            },
+            query: {
+                expand,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: copyPageRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json;charset=UTF-8": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.copyPage.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Copy page hierarchy allows the copying of an entire hierarchy of pages and
+     * their associated properties, permissions and attachments.
+     *  The id path parameter refers to the content id of the page to copy, and the
+     * new parent of this copied page is defined using the destinationPageId in the
+     * request body.
+     *  The titleOptions object defines the rules of renaming page titles during the
+     * copy;
+     *  for example, search and replace can be used in conjunction to rewrite the
+     * copied page titles.
+     *
+     *  Response example:
+     *  <pre><code>
+     *  {
+     *       "id" : "1180606",
+     *       "links" : {
+     *            "status" : "/rest/api/longtask/1180606"
+     *       }
+     *  }
+     *  </code></pre>
+     *  Use the /longtask/<taskId> REST API to get the copy task status.
+     *
+     * @returns Returns a full JSON representation of a long running task
+     * @path {POST} /wiki/rest/api/content/{id}/pagehierarchy/copy
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content.metadata:confluence, write:page:confluence
+     */
+    copyPageHierarchy({ id, copyPageHierarchyRequest, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/pagehierarchy/copy",
+            method: "POST",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: copyPageHierarchyRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            202: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.copyPageHierarchy.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns a map of the direct children of a piece of content. A piece of content
+     * has different types of child content, depending on its type. These are
+     * the default parent-child content type relationships:
+     *
+     * - `page`: child content is `page`, `whiteboard`, `database`, `embed`, `folder`,
+     * `comment`, `attachment`
+     * - `whiteboard`: child content is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `database`: child content is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `embed`: child content is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `folder`: child content is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `blogpost`: child content is `comment`, `attachment`
+     * - `attachment`: child content is `comment`
+     * - `comment`: child content is `attachment`
+     *
+     * Apps can override these default relationships. Apps can also introduce
+     * new content types that create new parent-child content relationships.
+     *
+     * Note, the map will always include all child content types that are valid
+     * for the content. However, if the content has no instances of a child content
+     * type, the map will contain an empty array for that child content type.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
+     * permission for the space,
+     * and permission to view the content if it is a page.
+     *
+     * @deprecated
+     * @returns Returned if the requested content children are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/child
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentChildren({ id, expand, parentVersion, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/child",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                expand,
+                parentVersion,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.getContentChildren.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns all children of a given type, for a piece of content.
+     * A piece of content has different types of child content, depending on its type:
+     *
+     * - `page`: child content is `page`, `whiteboard`, `database`, `embed`, `folder`,
+     * `comment`, `attachment`
+     * - `whiteboard`: child content is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `database`: child content is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `embed`: child content is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `folder`: child content is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `blogpost`: child content is `comment`, `attachment`
+     * - `attachment`: child content is `comment`
+     * - `comment`: child content is `attachment`
+     *
+     * Custom content types that are provided by apps can also be returned.
+     *
+     * Note, this method only returns direct children. To return children at all
+     * levels, use [Get descendants by type](#api-content-id-descendant-type-get).
+     *
+     * 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,
+     * and permission to view the content if it is a page.
+     *
+     * @deprecated
+     * @returns Returned if the requested content is returned.
+     * @path {GET} /wiki/rest/api/content/{id}/child/{type}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentChildrenByType({ id, type, expand, parentVersion, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/child/{type}",
+            method: "GET",
+            pathParams: {
+                id,
+                type,
+            },
+            query: {
+                expand,
+                parentVersion,
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.getContentChildrenByType.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a map of the descendants of a piece of content. This is similar
+     * to [Get content children](#api-content-id-child-get), except that this
+     * method returns child pages at all levels, rather than just the direct
+     * child pages.
+     *
+     * A piece of content has different types of descendants, depending on its type:
+     *
+     * - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
+     * `comment`, `attachment`
+     * - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `database`: descendant is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
+     * `comment`, `attachment`
+     * - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
+     * `comment`, `attachment`
+     * - `blogpost`: descendant is `comment`, `attachment`
+     * - `attachment`: descendant is `comment`
+     * - `comment`: descendant is `attachment`
+     *
+     * The map will always include all descendant types that are valid for the content.
+     * However, if the content has no instances of a descendant type, the map will
+     * contain an empty array for that descendant type.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space, and permission to view the content if it
+     * is a page.
+     *
+     * @returns Returned if the requested descendants are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/descendant
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentDescendants({ id, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/descendant",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.getContentDescendants.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all descendants of a given type, for a piece of content. This is
+     * similar to [Get content children by type](#api-content-id-child-type-get),
+     * except that this method returns child pages at all levels, rather than just
+     * the direct child pages.
+     *
+     * A piece of content has different types of descendants, depending on its type:
+     *
+     * - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
+     * `comment`, `attachment`
+     * - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `database`: descendant is `page`, `whiteboard`, `database`, `embed`,
+     * `folder`, `comment`, `attachment`
+     * - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
+     * `comment`, `attachment`
+     * - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
+     * `comment`, `attachment`
+     * - `blogpost`: descendant is `comment`, `attachment`
+     * - `attachment`: descendant is `comment`
+     * - `comment`: descendant is `attachment`
+     *
+     * Custom content types that are provided by apps can also be returned.
+     *
+     * 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, and permission to view the content if it
+     * is a page.
+     *
+     * @returns Returned if the requested content is returned.
+     * @path {GET} /wiki/rest/api/content/{id}/descendant/{type}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getDescendantsOfType({ id, type, depth, expand, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/descendant/{type}",
+            method: "GET",
+            pathParams: {
+                id,
+                type,
+            },
+            query: {
+                depth,
+                expand,
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.getDescendantsOfType.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Move a page to a new location relative to a target page:
+     *
+     * * `before` - move the page under the same parent as the target, before the
+     * target in the list of children
+     * * `after` - move the page under the same parent as the target, after the target
+     * in the list of children
+     * * `append` - move the page to be a child of the target
+     *
+     * Caution: This API can move pages to the top level of a space. Top-level pages
+     * are difficult to find in the UI
+     * because they do not show up in the page tree display. To avoid this, never use
+     * `before` or `after` positions
+     * when the `targetId` is a top-level page.
+     *
+     * @returns Page was successfully moved
+     * @path {PUT} /wiki/rest/api/content/{pageId}/move/{position}/{targetId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:page:confluence
+     */
+    movePage({ pageId, position, targetId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{pageId}/move/{position}/{targetId}",
+            method: "PUT",
+            pathParams: {
+                pageId,
+                position,
+                targetId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.movePage.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.getContentChildren.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentChildren"),
+        })
+            .describe("ContentChildrenAndDescendantsService.getContentChildren.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.getContentChildrenByType.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentArray"),
+        })
+            .describe("ContentChildrenAndDescendantsService.getContentChildrenByType.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.copyPage.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json;charset=UTF-8"),
+            body: zod_1.z.nullable(validationSchemaStorage_1.validationSchemaStorage.lazy("Content")),
+        })
+            .describe("ContentChildrenAndDescendantsService.copyPage.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.getContentDescendants.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentChildren"),
+        })
+            .describe("ContentChildrenAndDescendantsService.getContentDescendants.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.getDescendantsOfType.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentArray"),
+        })
+            .describe("ContentChildrenAndDescendantsService.getDescendantsOfType.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.copyPageHierarchy.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(202),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("LongTask"),
+        })
+            .describe("ContentChildrenAndDescendantsService.copyPageHierarchy.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.movePage.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                pageId: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentId").optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("ContentChildrenAndDescendantsService.movePage.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.ContentChildrenAndDescendantsService = ContentChildrenAndDescendantsService;
+//# sourceMappingURL=ContentChildrenAndDescendantsService.js.map

package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentChildrenAndDescendantsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentChildrenAndDescendantsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAO0B;AAK1B,wEAAqE;AACrE,MAAa,oCAAqC,SAAQ,qCAAiB;IACzE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CAAC,EACP,EAAE,EACF,MAAM,EACN,eAAe,GAqGhB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,kCAAkC;YACxC,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;aACP;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,eAAe;SACtB,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,gCAAgC,EAAE,MAAM;aACzC;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wDAAwD,CACzD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,iBAAiB,CAAC,EAChB,EAAE,EACF,wBAAwB,GAKzB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;aACH;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,wBAAwB;SAC/B,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,iEAAiE,CAClE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,kBAAkB,CAAC,EACjB,EAAE,EACF,MAAM,EACN,aAAa,GAuBd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,aAAa;aACd;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,kEAAkE,CACnE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,wBAAwB,CAAC,EACvB,EAAE,EACF,IAAI,EACJ,MAAM,EACN,aAAa,EACb,KAAK,EACL,KAAK,GAiHN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,0CAA0C;YAChD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;gBACF,IAAI;aACL;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wEAAwE,CACzE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,qBAAqB,CAAC,EACpB,EAAE,EACF,MAAM,GAiBP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,wCAAwC;YAC9C,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;aACP;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,qEAAqE,CACtE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,oBAAoB,CAAC,EACnB,EAAE,EACF,IAAI,EACJ,KAAK,EACL,MAAM,EACN,KAAK,EACL,KAAK,GAsHN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+CAA+C;YACrD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;gBACF,IAAI;aACL;YACD,KAAK,EAAE;gBACL,KAAK;gBACL,MAAM;gBACN,KAAK;gBACL,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oEAAoE,CACrE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,EACP,MAAM,EACN,QAAQ,EACR,QAAQ,GAeT;QAOC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4DAA4D;YAClE,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,MAAM;gBACN,QAAQ;gBACR,QAAQ;aACT;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAQzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wDAAwD,CACzD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,kEAAkE,EAClE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CACP,kEAAkE,CACnE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,wEAAwE,EACxE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CACP,wEAAwE,CACzE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,gCAAgC,CAAC;YACtD,IAAI,EAAE,OAAC,CAAC,QAAQ,CAAC,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC1D,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,qEAAqE,EACrE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CACP,qEAAqE,CACtE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,oEAAoE,EACpE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CACP,oEAAoE,CACrE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iEAAiE,EACjE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,UAAU,CAAC;SAC/C,CAAC;aACD,QAAQ,CACP,iEAAiE,CAClE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,MAAM,EAAE,iDAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE;aAC7D,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAr9BD,oFAq9BC"}

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

@@ -0,0 +1,147 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type ContentArray } from "../models/common";
+/** @deprecated */
+export declare class ContentCommentsService extends CommonHttpService {
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns the comments on a piece of content.
+     *
+     * 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,
+     * and permission to view the content if it is a page.
+     *
+     * @deprecated
+     * @returns Returned if the requested comments are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/child/comment
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentComments({ id, expand, parentVersion, start, limit, location, depth, }: {
+        /** The ID of the content to be queried for its comments. */
+        id: 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[];
+        /**
+         * The version of the parent content to retrieve children for.
+         * Currently, this only works for the latest version.
+         */
+        parentVersion?: number;
+        /** The starting index of the returned comments. */
+        start?: number;
+        /**
+         * The maximum number of comments to return per page. Note,
+         * this may be restricted by fixed system limits.
+         */
+        limit?: number;
+        /**
+         * The location of the comments in the page. Multiple locations can be specified.
+         * If no location is specified, comments from all locations are returned.
+         */
+        location?: "inline" | "footer" | "resolved";
+        /**
+         * Currently, this parameter is not used.
+         * Comments are returned at the root level only.
+         */
+        depth?: string;
+    }): Promise<ContentArray>;
+    static initialize(): void;
+}