@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,285 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentPropertiesService = 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 contentProperties_1 = require("../models/contentProperties");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+/** @deprecated */
+class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Creates a property for an existing piece of content. For more information
+     * about content properties, see [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     *
+     * This is the same as [Create content property for
+     * key](#api-content-id-property-key-post)
+     * except that the key is specified in the request body instead of as a
+     * path parameter.
+     *
+     * Content properties can also be added when creating a new piece of content
+     * by including them in the `metadata.properties` of the request.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @deprecated
+     * @returns Returned if the content property is created.
+     * @path {POST} /wiki/rest/api/content/{id}/property
+     * @scopes-current write:confluence-props
+     * @scopes-beta read:content.property:confluence, write:content.property:confluence
+     */
+    createContentProperty({ id, contentPropertyCreate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/property",
+            method: "POST",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: contentPropertyCreate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createContentProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Creates a property for an existing piece of content. For more information
+     * about content properties, see [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     *
+     * This is the same as [Create content property](#api-content-id-property-post)
+     * except that the key is specified as a path parameter instead of in the
+     * request body.
+     *
+     * Content properties can also be added when creating a new piece of content
+     * by including them in the `metadata.properties` of the request.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @deprecated
+     * @returns Returned if the content property is created.
+     * @path {POST} /wiki/rest/api/content/{id}/property/{key}
+     * @scopes-current write:confluence-props
+     * @scopes-beta read:content.property:confluence, write:content.property:confluence
+     */
+    createContentPropertyForKey({ id, key, contentPropertyCreateNoKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/property/{key}",
+            method: "POST",
+            pathParams: {
+                id,
+                key,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: contentPropertyCreateNoKey,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createContentPropertyForKey.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deletes a content property. For more information about content properties, see
+     * [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @deprecated
+     * @path {DELETE} /wiki/rest/api/content/{id}/property/{key}
+     * @scopes-current write:confluence-props
+     * @scopes-beta write:content.property:confluence
+     */
+    deleteContentProperty({ id, key, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/property/{key}",
+            method: "DELETE",
+            pathParams: {
+                id,
+                key,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns the properties for a piece of content. For more information
+     * about content properties, see [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space, and permission to view the content if it is a
+     * page.
+     *
+     * @deprecated
+     * @returns Returned if the requested properties are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/property
+     * @scopes-current read:confluence-props
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentProperties({ id, key, expand, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/property",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+            query: {
+                key,
+                expand,
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getContentProperties.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a content property for a piece of content. For more information, see
+     * [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'View' permission for the space, and permission to view the content if it is a
+     * page.
+     *
+     * @deprecated
+     * @returns Returned if the content property is returned.
+     * @path {GET} /wiki/rest/api/content/{id}/property/{key}
+     * @scopes-current read:confluence-props
+     * @scopes-beta read:content-details:confluence
+     */
+    getContentProperty({ id, key, expand, status, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/property/{key}",
+            method: "GET",
+            pathParams: {
+                id,
+                key,
+            },
+            query: {
+                expand,
+                status,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getContentProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates an existing content property. This method will also create a new
+     * property for a piece of content, if the property key does not exist and
+     * the property version is 1. For more information about content properties, see
+     * [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @deprecated
+     * @returns Returned if the content property is created.
+     * @path {PUT} /wiki/rest/api/content/{id}/property/{key}
+     * @scopes-current write:confluence-props
+     * @scopes-beta read:content.property:confluence, write:content.property:confluence
+     */
+    updateContentProperty({ id, key, contentPropertyUpdate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/property/{key}",
+            method: "PUT",
+            pathParams: {
+                id,
+                key,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: contentPropertyUpdate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateContentProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentPropertiesService.getContentProperties.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentPropertyArray"),
+        })
+            .describe("ContentPropertiesService.getContentProperties.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentPropertiesService.createContentProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentPropertyV1"),
+        })
+            .describe("ContentPropertiesService.createContentProperty.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentPropertiesService.getContentProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentPropertyV1"),
+        })
+            .describe("ContentPropertiesService.getContentProperty.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentPropertiesService.updateContentProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentPropertyV1"),
+        })
+            .describe("ContentPropertiesService.updateContentProperty.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentPropertiesService.createContentPropertyForKey.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentPropertyV1"),
+        })
+            .describe("ContentPropertiesService.createContentPropertyForKey.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            contentProperties_1.registerContentPropertiesValidationSchemas,
+        ]);
+    }
+}
+exports.ContentPropertiesService = ContentPropertiesService;
+//# sourceMappingURL=ContentPropertiesService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ContentPropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentPropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mEAOqC;AACrC,wEAAqE;AACrE,kBAAkB;AAClB,MAAa,wBAAyB,SAAQ,qCAAiB;IAC7D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,qBAAqB,CAAC,EACpB,EAAE,EACF,qBAAqB,GAMtB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sCAAsC;YAC5C,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;aACH;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,qBAAqB;SAC5B,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,yDAAyD,CAC1D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,2BAA2B,CAAC,EAC1B,EAAE,EACF,GAAG,EACH,0BAA0B,GAQ3B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;gBACF,GAAG;aACJ;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,0BAA0B;SACjC,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,+DAA+D,CAChE,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EACpB,EAAE,EACF,GAAG,GAMJ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;gBACF,GAAG;aACJ;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,EACnB,EAAE,EACF,GAAG,EACH,MAAM,EACN,KAAK,EACL,KAAK,GAsBN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sCAAsC;YAC5C,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,GAAG;gBACH,MAAM;gBACN,KAAK;gBACL,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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wDAAwD,CACzD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAAC,EACjB,EAAE,EACF,GAAG,EACH,MAAM,EACN,MAAM,GA6BP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;gBACF,GAAG;aACJ;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,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,sDAAsD,CACvD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,CAAC,EACpB,EAAE,EACF,GAAG,EACH,qBAAqB,GAQtB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;gBACF,GAAG;aACJ;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,qBAAqB;SAC5B,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,yDAAyD,CAC1D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,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,sBAAsB,CAAC;SAC3D,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yDAAyD,EACzD,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,mBAAmB,CAAC;SACxD,CAAC;aACD,QAAQ,CAAC,yDAAyD,CAAC,CACvE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sDAAsD,EACtD,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,mBAAmB,CAAC;SACxD,CAAC;aACD,QAAQ,CAAC,sDAAsD,CAAC,CACpE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yDAAyD,EACzD,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,mBAAmB,CAAC;SACxD,CAAC;aACD,QAAQ,CAAC,yDAAyD,CAAC,CACvE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,+DAA+D,EAC/D,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,mBAAmB,CAAC;SACxD,CAAC;aACD,QAAQ,CACP,+DAA+D,CAChE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,8DAA0C;SAC3C,CAAC,CAAC;IACL,CAAC;CACF;AA7bD,4DA6bC"}