@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,121 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type VersionV1 } from "../models/common";
+import { type VersionArray, type VersionRestore } from "../models/contentVersions";
+export declare class ContentVersionsService extends CommonHttpService {
+    /**
+     * Delete a historical version. This does not delete the changes made to the
+     * content in that version, rather the changes for the deleted version are
+     * rolled up into the next version. Note, you cannot delete the current version.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @path {DELETE} /wiki/rest/api/content/{id}/version/{versionNumber}
+     * @scopes-current write:confluence-content
+     * @scopes-beta delete:content:confluence
+     */
+    deleteContentVersion({ id, versionNumber, }: {
+        /** The ID of the content that the version will be deleted from. */
+        id: string;
+        /**
+         * The number of the version to be deleted. The version number starts
+         * from 1 up to current version.
+         */
+        versionNumber: number;
+    }): Promise<void>;
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns a version for a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content. If the content is a blog post, 'View' permission
+     * for the space is required.
+     *
+     * @deprecated
+     * @returns Returned if the version is returned.
+     * @path {GET} /wiki/rest/api/content/{id}/version/{versionNumber}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentVersion({ id, versionNumber, expand, }: {
+        /** The ID of the content to be queried for its version. */
+        id: string;
+        /** The number of the version to be retrieved. */
+        versionNumber: number;
+        /**
+         * A multi-value parameter indicating which properties of the content to expand.
+         * By default, the `content`
+         * object is expanded.
+         *
+         * - `collaborators` returns the users that collaborated on the version.
+         * - `content` returns the content for the version.
+         */
+        expand?: string[];
+    }): Promise<VersionV1 | null>;
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns the versions for a piece of content in descending order.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content. If the content is a blog post, 'View' permission
+     * for the space is required.
+     *
+     * @deprecated
+     * @returns Returned if the requested versions are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/version
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentVersions({ id, start, limit, expand, }: {
+        /** The ID of the content to be queried for its versions. */
+        id: string;
+        /** The starting index of the returned versions. */
+        start?: number;
+        /**
+         * The maximum number of versions to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+        /**
+         * A multi-value parameter indicating which properties of the content to expand.
+         * By default, the `content`
+         * object is expanded.
+         *
+         * - `collaborators` returns the users that collaborated on the version.
+         * - `content` returns the content for the version.
+         */
+        expand?: string[];
+    }): Promise<VersionArray>;
+    /**
+     * Restores a historical version to be the latest version. That is, a new version
+     * is created with the content of the historical version.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the version is restored.
+     * @path {POST} /wiki/rest/api/content/{id}/version
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:content:confluence
+     */
+    restoreContentVersion({ id, expand, versionRestore, }: {
+        /** The ID of the content for which the history will be restored. */
+        id: string;
+        /**
+         * A multi-value parameter indicating which properties of the content to expand.
+         * By default, the `content`
+         * object is expanded.
+         *
+         * - `collaborators` returns the users that collaborated on the version.
+         * - `content` returns the content for the version.
+         */
+        expand?: string[];
+        /** The content version to be restored. */
+        versionRestore: VersionRestore;
+    }): Promise<VersionV1 | null>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentVersionsService = 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 contentVersions_1 = require("../models/contentVersions");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class ContentVersionsService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Delete a historical version. This does not delete the changes made to the
+     * content in that version, rather the changes for the deleted version are
+     * rolled up into the next version. Note, you cannot delete the current version.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @path {DELETE} /wiki/rest/api/content/{id}/version/{versionNumber}
+     * @scopes-current write:confluence-content
+     * @scopes-beta delete:content:confluence
+     */
+    deleteContentVersion({ id, versionNumber, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/version/{versionNumber}",
+            method: "DELETE",
+            pathParams: {
+                id,
+                versionNumber,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns a version for a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content. If the content is a blog post, 'View' permission
+     * for the space is required.
+     *
+     * @deprecated
+     * @returns Returned if the version is returned.
+     * @path {GET} /wiki/rest/api/content/{id}/version/{versionNumber}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentVersion({ id, versionNumber, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/version/{versionNumber}",
+            method: "GET",
+            pathParams: {
+                id,
+                versionNumber,
+            },
+            query: {
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentVersionsService.getContentVersion.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns the versions for a piece of content in descending order.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content. If the content is a blog post, 'View' permission
+     * for the space is required.
+     *
+     * @deprecated
+     * @returns Returned if the requested versions are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/version
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentVersions({ id, start, limit, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/version",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                start,
+                limit,
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentVersionsService.getContentVersions.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Restores a historical version to be the latest version. That is, a new version
+     * is created with the content of the historical version.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the version is restored.
+     * @path {POST} /wiki/rest/api/content/{id}/version
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:content:confluence
+     */
+    restoreContentVersion({ id, expand, versionRestore, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/version",
+            method: "POST",
+            pathParams: {
+                id,
+            },
+            query: {
+                expand,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: versionRestore,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentVersionsService.restoreContentVersion.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentVersionsService.getContentVersions.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("VersionArray"),
+        })
+            .describe("ContentVersionsService.getContentVersions.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentVersionsService.restoreContentVersion.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.nullable(validationSchemaStorage_1.validationSchemaStorage.lazy("VersionV1")),
+        })
+            .describe("ContentVersionsService.restoreContentVersion.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentVersionsService.getContentVersion.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.nullable(validationSchemaStorage_1.validationSchemaStorage.lazy("VersionV1")),
+        })
+            .describe("ContentVersionsService.getContentVersion.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            contentVersions_1.registerContentVersionsValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.ContentVersionsService = ContentVersionsService;
+//# sourceMappingURL=ContentVersionsService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContentVersionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentVersionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,+DAImC;AACnC,wEAAqE;AACrE,MAAa,sBAAuB,SAAQ,qCAAiB;IAC3D;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAC,EACnB,EAAE,EACF,aAAa,GASd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,qDAAqD;YAC3D,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;gBACF,aAAa;aACd;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CAAC,EAChB,EAAE,EACF,aAAa,EACb,MAAM,GAeP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,qDAAqD;YAC3D,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;gBACF,aAAa;aACd;YACD,KAAK,EAAE;gBACL,MAAM;aACP;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,mDAAmD,CACpD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,EACjB,EAAE,EACF,KAAK,EACL,KAAK,EACL,MAAM,GAoBP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,qCAAqC;YAC3C,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,KAAK;gBACL,KAAK;gBACL,MAAM;aACP;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,EACpB,EAAE,EACF,MAAM,EACN,cAAc,GAef;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,qCAAqC;YAC3C,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;aACP;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,cAAc;SACrB,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,uDAAuD,CACxD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,uDAAuD,EACvD,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,QAAQ,CAAC,iDAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC5D,CAAC;aACD,QAAQ,CAAC,uDAAuD,CAAC,CACrE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,mDAAmD,EACnD,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,QAAQ,CAAC,iDAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC5D,CAAC;aACD,QAAQ,CAAC,mDAAmD,CAAC,CACjE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,0DAAwC;YACxC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA1RD,wDA0RC"}