@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,381 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageService = 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 page_1 = require("../models/page");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class PageService extends CommonHttpService_1.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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages",
+            method: "POST",
+            query: {
+                embedded,
+                private: privateQuery,
+                "root-level": rootLevel,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("PageService.createPage.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages/{id}",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+            query: {
+                purge,
+                draft,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/labels/{id}/pages",
+            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("PageService.getLabelPages.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages/{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("PageService.getPageById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages",
+            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("PageService.getPages.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/spaces/{id}/pages",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                depth,
+                sort,
+                status,
+                title,
+                "body-format": bodyFormat,
+                cursor,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("PageService.getPagesInSpace.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * 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, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/pages/{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("PageService.updatePage.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("PageService.getLabelPages.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("PageBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("PageService.getLabelPages.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("PageService.getPages.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("PageBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("PageService.getPages.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("PageService.createPage.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("PageSingle"), 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("PageService.createPage.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("PageService.getPageById.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("PageSingle"), 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("PageService.getPageById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("PageService.updatePage.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("PageSingle"), 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("PageService.updatePage.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("PageService.getPagesInSpace.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("PageBulk"))
+                    .optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("PageService.getPagesInSpace.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            page_1.registerPageValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.PageService = PageService;
+//# sourceMappingURL=PageService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PageService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/PageService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAK0B;AAC1B,yCAOwB;AACxB,wEAAqE;AACrE,MAAa,WAAY,SAAQ,qCAAiB;IAChD;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EACT,QAAQ,EACR,OAAO,EAAE,YAAY,EACrB,SAAS,EACT,WAAW,GA2BZ;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,MAAM;YACd,KAAK,EAAE;gBACL,QAAQ;gBACR,OAAO,EAAE,YAAY;gBACrB,YAAY,EAAE,SAAS;aACxB;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,CAAC,iCAAiC,CAAC,CACrE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,UAAU,CAAC,EACT,EAAE,EACF,KAAK,EACL,KAAK,GAQN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,aAAa;YACnB,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;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EACZ,EAAE,EACF,OAAO,EACP,UAAU,EACV,IAAI,EACJ,MAAM,EACN,KAAK,GA6BN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oBAAoB;YAC1B,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,CAAC,oCAAoC,CAAC,CACxE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,WAAW,CAAC,EACV,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,aAAa;YACnB,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,CAAC,kCAAkC,CAAC,CACtE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EACP,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,QAAQ;YACd,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,CAAC,iDAAuB,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;aACxE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EACd,EAAE,EACF,KAAK,EACL,IAAI,EACJ,MAAM,EACN,KAAK,EACL,UAAU,EACV,MAAM,EACN,KAAK,GAoCN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oBAAoB;YAC1B,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,KAAK;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,sCAAsC,CACvC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EACT,EAAE,EACF,WAAW,GA2DZ;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,aAAa;YACnB,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,CAAC,iCAAiC,CAAC,CACrE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,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,UAAU,CAAC,CAAC;qBAC/C,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,oCAAoC,CAAC,CAClD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,+BAA+B,EAC/B,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,UAAU,CAAC,CAAC;qBAC/C,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,+BAA+B,CAAC,CAC7C,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iCAAiC,EACjC,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,YAAY,CAAC,EAC1C,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,iCAAiC,CAAC,CAC/C,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,kCAAkC,EAClC,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,YAAY,CAAC,EAC1C,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,kCAAkC,CAAC,CAChD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iCAAiC,EACjC,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,YAAY,CAAC,EAC1C,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,iCAAiC,CAAC,CAC/C,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sCAAsC,EACtC,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,UAAU,CAAC,CAAC;qBAC/C,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,sCAAsC,CAAC,CACpD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,oCAA6B;YAC7B,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA51BD,kCA41BC"}

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

@@ -0,0 +1,84 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type SmartLinkSingle } from "../models/smartLink";
+export declare class SmartLinkService extends CommonHttpService {
+    /**
+     * Creates a Smart Link in the content tree in the space.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the corresponding space. Permission to create a Smart Link
+     * in the content tree in the space.
+     *
+     * @returns Returned if the Smart Link was successfully created in the content tree.
+     * @path {POST} /embeds
+     * @scopes-current write:embed:confluence
+     */
+    createSmartLink({ private: privateQuery, requestBody, }: {
+        /**
+         * The Smart Link will be private. Only the user who creates this Smart Link in
+         * the content tree will have permission to view and edit one.
+         */
+        private?: boolean;
+        requestBody: {
+            /** ID of the space. */
+            spaceId: string;
+            /** Title of the Smart Link in the content tree. */
+            title?: string;
+            /** The parent content ID of the Smart Link in the content tree. */
+            parentId?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    }): Promise<SmartLinkSingle & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    /**
+     * Delete a Smart Link in the content tree by id.
+     *
+     * Deleting a Smart Link in the content tree moves the Smart Link to the trash,
+     * where it can be restored later
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the Smart Link in the content tree and its corresponding
+     * space.
+     * Permission to delete Smart Links in the content tree in the space.
+     *
+     * @path {DELETE} /embeds/{id}
+     * @scopes-current delete:embed:confluence
+     */
+    deleteSmartLink({ id, }: {
+        /** The ID of the Smart Link in the content tree to be deleted. */
+        id: number;
+    }): Promise<void>;
+    /**
+     * Returns a specific Smart Link in the content tree.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the Smart Link in the content tree and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested Smart Link in the content tree is returned.
+     * @path {GET} /embeds/{id}
+     * @scopes-current read:embed:confluence
+     */
+    getSmartLinkById({ id, }: {
+        /** The ID of the Smart Link in the content tree to be returned. */
+        id: number;
+    }): Promise<SmartLinkSingle & ({
+        _links?: {
+            /** Base url of the Confluence site. */
+            base?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmartLinkService = 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 smartLink_1 = require("../models/smartLink");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class SmartLinkService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Creates a Smart Link in the content tree in the space.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the corresponding space. Permission to create a Smart Link
+     * in the content tree in the space.
+     *
+     * @returns Returned if the Smart Link was successfully created in the content tree.
+     * @path {POST} /embeds
+     * @scopes-current write:embed:confluence
+     */
+    createSmartLink({ private: privateQuery, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/embeds",
+            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("SmartLinkService.createSmartLink.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Delete a Smart Link in the content tree by id.
+     *
+     * Deleting a Smart Link in the content tree moves the Smart Link to the trash,
+     * where it can be restored later
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the Smart Link in the content tree and its corresponding
+     * space.
+     * Permission to delete Smart Links in the content tree in the space.
+     *
+     * @path {DELETE} /embeds/{id}
+     * @scopes-current delete:embed:confluence
+     */
+    deleteSmartLink({ id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/embeds/{id}",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns a specific Smart Link in the content tree.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the Smart Link in the content tree and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested Smart Link in the content tree is returned.
+     * @path {GET} /embeds/{id}
+     * @scopes-current read:embed:confluence
+     */
+    getSmartLinkById({ id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/embeds/{id}",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SmartLinkService.getSmartLinkById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SmartLinkService.createSmartLink.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("SmartLinkSingle"), 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("SmartLinkService.createSmartLink.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SmartLinkService.getSmartLinkById.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("SmartLinkSingle"), 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("SmartLinkService.getSmartLinkById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([smartLink_1.registerSmartLinkValidationSchemas]);
+    }
+}
+exports.SmartLinkService = SmartLinkService;
+//# sourceMappingURL=SmartLinkService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SmartLinkService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SmartLinkService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mDAG6B;AAC7B,wEAAqE;AACrE,MAAa,gBAAiB,SAAQ,qCAAiB;IACrD;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EACd,OAAO,EAAE,YAAY,EACrB,WAAW,GAiBZ;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,SAAS;YACf,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,2CAA2C,CAC5C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EACd,EAAE,GAIH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,cAAc;YACpB,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;aACH;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,EACf,EAAE,GAIH;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,cAAc;YACpB,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;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,4CAA4C,CAC7C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,2CAA2C,EAC3C,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,iBAAiB,CAAC,EAC/C,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,2CAA2C,CAAC,CACzD,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,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAC/C,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,4CAA4C,CAAC,CAC1D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,8CAAkC,CAAC,CAAC,CAAC;IAC7E,CAAC;CACF;AAtOD,4CAsOC"}

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

@@ -0,0 +1,36 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type MultiEntityLinks, type SpacePermission } from "../models/common";
+export declare class SpacePermissionsService extends CommonHttpService {
+    /**
+     * Returns space permissions for a specific space.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the space.
+     *
+     * @returns Returned if the requested space permissions are returned.
+     * @path {GET} /spaces/{id}/permissions
+     * @scopes-current read:space:confluence
+     */
+    getSpacePermissions({ id, cursor, limit, }: {
+        /** The ID of the space to be returned. */
+        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 spaces per result to return. If more results exist, use the
+         * `Link` response header to retrieve a relative URL that will return the next set
+         * of results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: SpacePermission[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    static initialize(): void;
+}