@resolution/confluence-api-client 0.2.0

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/DatabaseService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iDAG4B;AAC5B,wEAAqE;AACrE,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EACb,OAAO,EAAE,YAAY,EACrB,WAAW,GAiBZ;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;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EACb,EAAE,GAIH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;aACH;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;OASG;IACH,eAAe,CAAC,EACd,EAAE,GAIH;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iBAAiB;YACvB,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,0CAA0C,CAC3C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;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,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AApOD,0CAoOC"}

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

@@ -0,0 +1,271 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type Label, type MultiEntityLinks } from "../models/common";
+export declare class LabelService extends CommonHttpService {
+    /**
+     * Returns the labels of specific attachment. 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 parent content of the attachment and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested labels are returned.
+     * @path {GET} /attachments/{id}/labels
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachmentLabels({ id, prefix, sort, cursor, limit, }: {
+        /** The ID of the attachment for which labels should be returned. */
+        id: number;
+        /** Filter the results to labels based on their prefix. */
+        prefix?: "my" | "team" | "global" | "system";
+        /** Used to sort the result by a particular field. */
+        sort?: string;
+        /**
+         * 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 labels per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: Label[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the labels of specific blog post. 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 blog post and its corresponding space.
+     *
+     * @returns Returned if the requested labels are returned.
+     * @path {GET} /blogposts/{id}/labels
+     * @scopes-current read:page:confluence
+     */
+    getBlogPostLabels({ id, prefix, sort, cursor, limit, }: {
+        /** The ID of the blog post for which labels should be returned. */
+        id: number;
+        /** Filter the results to labels based on their prefix. */
+        prefix?: "my" | "team" | "global" | "system";
+        /** Used to sort the result by a particular field. */
+        sort?: string;
+        /**
+         * 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 labels per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: Label[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the labels for a specific piece of custom content. 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 custom content and its corresponding space.
+     *
+     * @returns Returned if the requested labels are returned.
+     * @path {GET} /custom-content/{id}/labels
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentLabels({ id, prefix, sort, cursor, limit, }: {
+        /** The ID of the custom content for which labels should be returned. */
+        id: number;
+        /** Filter the results to labels based on their prefix. */
+        prefix?: "my" | "team" | "global" | "system";
+        /** Used to sort the result by a particular field. */
+        sort?: string;
+        /**
+         * 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 labels per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: Label[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns all labels. 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 labels that the user has permission to view will be returned.
+     *
+     * @returns Returned if the requested labels are returned.
+     * @path {GET} /labels
+     * @scopes-current read:label:confluence
+     */
+    getLabels({ labelId, prefix, cursor, sort, limit, }: {
+        /** Filters on label ID. Multiple IDs can be specified as a comma-separated list. */
+        labelId?: number[];
+        /**
+         * Filters on label prefix. Multiple IDs can be specified as a comma-separated
+         * list.
+         */
+        prefix?: string[];
+        /**
+         * 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;
+        /** Used to sort the result by a particular field. */
+        sort?: string;
+        /**
+         * Maximum number of labels per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: Label[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the labels of specific page. 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 labels are returned.
+     * @path {GET} /pages/{id}/labels
+     * @scopes-current read:page:confluence
+     */
+    getPageLabels({ id, prefix, sort, cursor, limit, }: {
+        /** The ID of the page for which labels should be returned. */
+        id: number;
+        /** Filter the results to labels based on their prefix. */
+        prefix?: "my" | "team" | "global" | "system";
+        /** Used to sort the result by a particular field. */
+        sort?: string;
+        /**
+         * 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 labels per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: Label[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the labels of space content (pages, blogposts etc). 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 space.
+     *
+     * @returns Returned if the requested labels are returned.
+     * @path {GET} /spaces/{id}/content/labels
+     * @scopes-current read:space:confluence
+     */
+    getSpaceContentLabels({ id, prefix, sort, cursor, limit, }: {
+        /** The ID of the space for which labels should be returned. */
+        id: number;
+        /** Filter the results to labels based on their prefix. */
+        prefix?: "my" | "team";
+        /** Used to sort the result by a particular field. */
+        sort?: string;
+        /**
+         * 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 labels per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: Label[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the labels of specific 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 view the space.
+     *
+     * @returns Returned if the requested labels are returned.
+     * @path {GET} /spaces/{id}/labels
+     * @scopes-current read:space:confluence
+     */
+    getSpaceLabels({ id, prefix, sort, cursor, limit, }: {
+        /** The ID of the space for which labels should be returned. */
+        id: number;
+        /** Filter the results to labels based on their prefix. */
+        prefix?: "my" | "team";
+        /** Used to sort the result by a particular field. */
+        sort?: string;
+        /**
+         * 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 labels per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+    }): Promise<{
+        results?: Label[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    static initialize(): void;
+}