@resolution/confluence-api-client 0.2.0

package/lib/openapi/v2/services/BlogPostService.js

@@ -0,0 +1,379 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlogPostService = 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 blogPost_1 = require("../models/blogPost");
+const common_1 = require("../models/common");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class BlogPostService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Creates a new blog post in the space specified by the spaceId.
+     *
+     * By default this will create the blog post as a non-draft, unless the status is
+     * specified as draft.
+     * If creating a non-draft, the title must not be empty.
+     *
+     * Currently only supports the storage representation specified in the
+     * body.representation enums below
+     *
+     * @returns Returned if the blog post was created successfully.
+     * @path {POST} /blogposts
+     * @scopes-current write:page:confluence
+     */
+    createBlogPost({ private: privateQuery, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/blogposts",
+            method: "POST",
+            query: {
+                private: privateQuery,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("BlogPostService.createBlogPost.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Delete a blog post by id.
+     *
+     * By default this will delete blog posts that are non-drafts. To delete a blog
+     * post 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 blog post that is not a draft moves the blog post to the trash,
+     * where it can be restored later.
+     * To permanently delete a blog post (or "purge" it), the endpoint must be called
+     * on a **trashed** blog post with the following param `purge=true`.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the blog post and its corresponding space.
+     * Permission to delete blog posts in the space.
+     * Permission to administer the space (if attempting to purge).
+     *
+     * @path {DELETE} /blogposts/{id}
+     * @scopes-current delete:page:confluence
+     */
+    deleteBlogPost({ id, purge, draft, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/blogposts/{id}",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+            query: {
+                purge,
+                draft,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns a specific blog post.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the blog post and its corresponding space.
+     *
+     * @returns Returned if the requested blog post is returned.
+     * @path {GET} /blogposts/{id}
+     * @scopes-current read:page:confluence
+     */
+    getBlogPostById({ id, bodyFormat, getDraft, version, includeLabels, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, includeFavoritedByCurrentUserStatus, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/blogposts/{id}",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                "body-format": bodyFormat,
+                "get-draft": getDraft,
+                version,
+                "include-labels": includeLabels,
+                "include-properties": includeProperties,
+                "include-operations": includeOperations,
+                "include-likes": includeLikes,
+                "include-versions": includeVersions,
+                "include-version": includeVersion,
+                "include-favorited-by-current-user-status": includeFavoritedByCurrentUserStatus,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("BlogPostService.getBlogPostById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all blog posts. 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 blog posts that the user has permission to view will be returned.
+     *
+     * @returns Returned if the requested blog posts are returned.
+     * @path {GET} /blogposts
+     * @scopes-current read:page:confluence
+     */
+    getBlogPosts({ id, spaceId, sort, status, title, bodyFormat, cursor, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/blogposts",
+            method: "GET",
+            query: {
+                id,
+                "space-id": spaceId,
+                sort,
+                status,
+                title,
+                "body-format": bodyFormat,
+                cursor,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("BlogPostService.getBlogPosts.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all blog posts 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
+     * the space.
+     * Only blog posts that the user has permission to view will be returned.
+     *
+     * @returns Returned if the requested blog posts are returned.
+     * @path {GET} /spaces/{id}/blogposts
+     * @scopes-current read:page:confluence
+     */
+    getBlogPostsInSpace({ id, sort, status, title, bodyFormat, cursor, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/spaces/{id}/blogposts",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                sort,
+                status,
+                title,
+                "body-format": bodyFormat,
+                cursor,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("BlogPostService.getBlogPostsInSpace.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the blogposts 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 blog posts for specified label were successfully
+     * fetched.
+     * @path {GET} /labels/{id}/blogposts
+     * @scopes-current read:page:confluence
+     */
+    getLabelBlogPosts({ id, spaceId, bodyFormat, sort, cursor, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/labels/{id}/blogposts",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                "space-id": spaceId,
+                "body-format": bodyFormat,
+                sort,
+                cursor,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("BlogPostService.getLabelBlogPosts.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Update a blog post by id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the blog post and its corresponding space. Permission to
+     * update blog posts in the space.
+     *
+     * @returns Returned if the requested blog post is successfully updated.
+     * @path {PUT} /blogposts/{id}
+     * @scopes-current write:page:confluence
+     */
+    updateBlogPost({ id, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/blogposts/{id}",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("BlogPostService.updateBlogPost.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("BlogPostService.getBlogPosts.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("BlogPostBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("BlogPostService.getBlogPosts.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("BlogPostService.createBlogPost.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("BlogPostSingle"), zod_1.z
+                .object({
+                _links: zod_1.z
+                    .object({
+                    base: zod_1.z.string().optional(),
+                })
+                    .catchall(zod_1.z.unknown())
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown())),
+        })
+            .describe("BlogPostService.createBlogPost.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("BlogPostService.getBlogPostById.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("BlogPostSingle"), zod_1.z
+                .object({
+                _links: zod_1.z
+                    .object({
+                    base: zod_1.z.string().optional(),
+                })
+                    .catchall(zod_1.z.unknown())
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown())),
+        })
+            .describe("BlogPostService.getBlogPostById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("BlogPostService.updateBlogPost.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("BlogPostSingle"), zod_1.z
+                .object({
+                _links: zod_1.z
+                    .object({
+                    base: zod_1.z.string().optional(),
+                })
+                    .catchall(zod_1.z.unknown())
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown())),
+        })
+            .describe("BlogPostService.updateBlogPost.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("BlogPostService.getLabelBlogPosts.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("BlogPostBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("BlogPostService.getLabelBlogPosts.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("BlogPostService.getBlogPostsInSpace.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("BlogPostBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("BlogPostService.getBlogPostsInSpace.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            blogPost_1.registerBlogPostValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.BlogPostService = BlogPostService;
+//# sourceMappingURL=BlogPostService.js.map

package/lib/openapi/v2/services/BlogPostService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlogPostService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/BlogPostService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iDAO4B;AAC5B,6CAK0B;AAC1B,wEAAqE;AACrE,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EACb,OAAO,EAAE,YAAY,EACrB,WAAW,GAqBZ;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE,MAAM;YACd,KAAK,EAAE;gBACL,OAAO,EAAE,YAAY;aACtB;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,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,EAazB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,CAAC,EACb,EAAE,EACF,KAAK,EACL,KAAK,GAQN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,KAAK;gBACL,KAAK;aACN;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;OASG;IACH,eAAe,CAAC,EACd,EAAE,EACF,UAAU,EACV,QAAQ,EACR,OAAO,EACP,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,mCAAmC,GAmEpC;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,aAAa,EAAE,UAAU;gBACzB,WAAW,EAAE,QAAQ;gBACrB,OAAO;gBACP,gBAAgB,EAAE,aAAa;gBAC/B,oBAAoB,EAAE,iBAAiB;gBACvC,oBAAoB,EAAE,iBAAiB;gBACvC,eAAe,EAAE,YAAY;gBAC7B,kBAAkB,EAAE,eAAe;gBACnC,iBAAiB,EAAE,cAAc;gBACjC,0CAA0C,EACxC,mCAAmC;aACtC;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,EAazB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EACX,EAAE,EACF,OAAO,EACP,IAAI,EACJ,MAAM,EACN,KAAK,EACL,UAAU,EACV,MAAM,EACN,KAAK,GAuCN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,EAAE;gBACF,UAAU,EAAE,OAAO;gBACnB,IAAI;gBACJ,MAAM;gBACN,KAAK;gBACL,aAAa,EAAE,UAAU;gBACzB,MAAM;gBACN,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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,uCAAuC,CACxC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAClB,EAAE,EACF,IAAI,EACJ,MAAM,EACN,KAAK,EACL,UAAU,EACV,MAAM,EACN,KAAK,GA+BN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;gBACN,KAAK;gBACL,aAAa,EAAE,UAAU;gBACzB,MAAM;gBACN,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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,8CAA8C,CAC/C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,EAChB,EAAE,EACF,OAAO,EACP,UAAU,EACV,IAAI,EACJ,MAAM,EACN,KAAK,GA6BN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,UAAU,EAAE,OAAO;gBACnB,aAAa,EAAE,UAAU;gBACzB,IAAI;gBACJ,MAAM;gBACN,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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,4CAA4C,CAC7C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EACb,EAAE,EACF,WAAW,GA+CZ;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,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,EAazB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,uCAAuC,EACvC,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,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;qBACnD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,uCAAuC,CAAC,CACrD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,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,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAC9C,OAAC;iBACE,MAAM,CAAC;gBACN,MAAM,EAAE,OAAC;qBACN,MAAM,CAAC;oBACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC;qBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;qBACrB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;SACF,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,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,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAC9C,OAAC;iBACE,MAAM,CAAC;gBACN,MAAM,EAAE,OAAC;qBACN,MAAM,CAAC;oBACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC;qBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;qBACrB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;SACF,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,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,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAC9C,OAAC;iBACE,MAAM,CAAC;gBACN,MAAM,EAAE,OAAC;qBACN,MAAM,CAAC;oBACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC;qBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;qBACrB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;SACF,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,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,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;qBACnD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,4CAA4C,CAAC,CAC1D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,8CAA8C,EAC9C,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,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;qBACnD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,8CAA8C,CAAC,CAC5D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,4CAAiC;YACjC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA50BD,0CA40BC"}

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

@@ -0,0 +1,85 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type ChildCustomContent, type ChildPage } from "../models/children";
+import { type MultiEntityLinks } from "../models/common";
+export declare class ChildrenService extends CommonHttpService {
+    /**
+     * Returns all child custom content for given custom content id. 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 custom content that the user has permission to view will be returned.
+     *
+     * @returns Returned if the requested child custom content are returned.
+     * @path {GET} /custom-content/{id}/children
+     * @scopes-current read:custom-content:confluence
+     */
+    getChildCustomContent({ id, cursor, limit, sort, }: {
+        /**
+         * The ID of the parent custom content. If you don't know the custom content ID,
+         * use Get custom-content and filter the results.
+         */
+        id: number;
+        /**
+         * 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;
+        /** Used to sort the result by a particular field. */
+        sort?: string;
+    }): Promise<{
+        results?: ChildCustomContent[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns all child pages for given page id. 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 child pages are returned.
+     * @path {GET} /pages/{id}/children
+     * @scopes-current read:page:confluence
+     */
+    getChildPages({ id, cursor, limit, sort, }: {
+        /**
+         * The ID of the parent page. If you don't know the page ID, use Get pages and
+         * filter the results.
+         */
+        id: number;
+        /**
+         * 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;
+        /** Used to sort the result by a particular field. */
+        sort?: string;
+    }): Promise<{
+        results?: ChildPage[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    static initialize(): void;
+}

package/lib/openapi/v2/services/ChildrenService.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChildrenService = 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 children_1 = require("../models/children");
+const common_1 = require("../models/common");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class ChildrenService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Returns all child custom content for given custom content id. 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 custom content that the user has permission to view will be returned.
+     *
+     * @returns Returned if the requested child custom content are returned.
+     * @path {GET} /custom-content/{id}/children
+     * @scopes-current read:custom-content:confluence
+     */
+    getChildCustomContent({ id, cursor, limit, sort, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/custom-content/{id}/children",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                cursor,
+                limit,
+                sort,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ChildrenService.getChildCustomContent.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all child pages for given page id. 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 child pages are returned.
+     * @path {GET} /pages/{id}/children
+     * @scopes-current read:page:confluence
+     */
+    getChildPages({ id, cursor, limit, sort, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages/{id}/children",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                cursor,
+                limit,
+                sort,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ChildrenService.getChildPages.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ChildrenService.getChildCustomContent.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("ChildCustomContent"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("ChildrenService.getChildCustomContent.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ChildrenService.getChildPages.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z
+                    .array(validationSchemaStorage_1.validationSchemaStorage.lazy("ChildPage"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("ChildrenService.getChildPages.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            children_1.registerChildrenValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.ChildrenService = ChildrenService;
+//# sourceMappingURL=ChildrenService.js.map

package/lib/openapi/v2/services/ChildrenService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChildrenService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/ChildrenService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iDAI4B;AAC5B,6CAG0B;AAC1B,wEAAqE;AACrE,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EACpB,EAAE,EACF,MAAM,EACN,KAAK,EACL,IAAI,GAqBL;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+BAA+B;YACrC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,KAAK;gBACL,IAAI;aACL;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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EACZ,EAAE,EACF,MAAM,EACN,KAAK,EACL,IAAI,GAqBL;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,KAAK;gBACL,IAAI;aACL;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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wCAAwC,CACzC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;qBACzD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,wCAAwC,EACxC,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,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;qBAChD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,wCAAwC,CAAC,CACtD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,4CAAiC;YACjC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AAxND,0CAwNC"}