@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentBodyService = 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 contentBody_1 = require("../models/contentBody");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class ContentBodyService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Converts a content body from one format to another format asynchronously.
+     * Returns the asyncId for the asynchronous task.
+     *
+     * Supported conversions:
+     *
+     * - storage: export_view
+     *
+     * No other conversions are supported at the moment.
+     * Once a conversion is completed, it will be available for 5 minutes at the
+     * result endpoint.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * If request specifies 'contentIdContext', 'View' permission for the space, and
+     * permission to view the content.
+     *
+     * @returns Returned if the content is added to the messaging queue for conversion. This id
+     * will be available for 5 minutes after the conversion is complete.
+     * @path {POST} /wiki/rest/api/contentbody/convert/async/{to}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.metadata:confluence
+     */
+    asyncConvertContentBodyRequest({ to, expand, spaceKeyContext, contentIdContext, allowCache, embeddedContentRender, contentBodyCreate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/contentbody/convert/async/{to}",
+            method: "POST",
+            pathParams: {
+                to,
+            },
+            query: {
+                expand,
+                spaceKeyContext,
+                contentIdContext,
+                allowCache,
+                embeddedContentRender,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: contentBodyCreate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentBodyService.asyncConvertContentBodyRequest.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the asynchronous content body for the corresponding id if the task is
+     * complete
+     * or returns the status of the task.
+     *
+     * After the task is completed, the result can be obtained for 5 minutes, or until
+     * an identical conversion request is made again,
+     * with allowCache query param set to false.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * If request specifies 'contentIdContext', 'View' permission for the space, and
+     * permission to view the content.
+     *
+     * @returns Returned if successfully found an async conversion task associated with the id.
+     * @path {GET} /wiki/rest/api/contentbody/convert/async/{id}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.metadata:confluence
+     */
+    asyncConvertContentBodyResponse({ id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/contentbody/convert/async/{id}",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentBodyService.asyncConvertContentBodyResponse.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Converts a content body from one format to another format.
+     *
+     * Supported conversions:
+     *
+     * - storage: view, export_view, styled_view, editor
+     * - editor: storage
+     * - view: none
+     * - export_view: none
+     * - styled_view: none
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * If request specifies 'contentIdContext', 'View' permission for the space, and
+     * permission to view the content.
+     *
+     * @returns Returned if the content is converted.
+     * @path {POST} /wiki/rest/api/contentbody/convert/{to}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.metadata:confluence
+     */
+    convertContentBody({ to, spaceKeyContext, contentIdContext, embeddedContentRender, expand, contentBodyCreate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/contentbody/convert/{to}",
+            method: "POST",
+            pathParams: {
+                to,
+            },
+            query: {
+                spaceKeyContext,
+                contentIdContext,
+                embeddedContentRender,
+                expand,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: contentBodyCreate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentBodyService.convertContentBody.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentBodyService.convertContentBody.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentBody"),
+        })
+            .describe("ContentBodyService.convertContentBody.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentBodyService.asyncConvertContentBodyResponse.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("AsyncContentBody"),
+        })
+            .describe("ContentBodyService.asyncConvertContentBodyResponse.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentBodyService.asyncConvertContentBodyRequest.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("AsyncId"),
+        })
+            .describe("ContentBodyService.asyncConvertContentBodyRequest.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            common_1.registerCommonValidationSchemas,
+            contentBody_1.registerContentBodyValidationSchemas,
+        ]);
+    }
+}
+exports.ContentBodyService = ContentBodyService;
+//# sourceMappingURL=ContentBodyService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContentBodyService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentBodyService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAK0B;AAC1B,uDAG+B;AAC/B,wEAAqE;AACrE,MAAa,kBAAmB,SAAQ,qCAAiB;IACvD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,8BAA8B,CAAC,EAC7B,EAAE,EACF,MAAM,EACN,eAAe,EACf,gBAAgB,EAChB,UAAU,EACV,qBAAqB,EACrB,iBAAiB,GAqFlB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+CAA+C;YACrD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,eAAe;gBACf,gBAAgB;gBAChB,UAAU;gBACV,qBAAqB;aACtB;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,iBAAiB;SACxB,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,4DAA4D,CAC7D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,+BAA+B,CAAC,EAC9B,EAAE,GAIH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+CAA+C;YACrD,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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,6DAA6D,CAC9D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBAAkB,CAAC,EACjB,EAAE,EACF,eAAe,EACf,gBAAgB,EAChB,qBAAqB,EACrB,MAAM,EACN,iBAAiB,GAwElB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yCAAyC;YAC/C,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,eAAe;gBACf,gBAAgB;gBAChB,qBAAqB;gBACrB,MAAM;aACP;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,iBAAiB;SACxB,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,gDAAgD,CACjD,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,iDAAuB,CAAC,IAAI,CAAC,aAAa,CAAC;SAClD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,6DAA6D,EAC7D,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,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CACP,6DAA6D,CAC9D,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4DAA4D,EAC5D,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,SAAS,CAAC;SAC9C,CAAC;aACD,QAAQ,CAAC,4DAA4D,CAAC,CAC1E,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,wCAA+B;YAC/B,kDAAoC;SACrC,CAAC,CAAC;IACL,CAAC;CACF;AAjYD,gDAiYC"}