@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,275 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpacePropertiesService = 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 spaceProperties_1 = require("../models/spaceProperties");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+/** @deprecated */
+class SpacePropertiesService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Creates a new space property.
+     *
+     * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
+     * ‘Admin’ permission for the space.
+     *
+     * @deprecated
+     * @returns Returned if the space property is created.
+     * @path {POST} /wiki/rest/api/space/{spaceKey}/property
+     * @scopes-current write:confluence-props
+     * @scopes-beta read:space.property:confluence, write:space.property:confluence
+     */
+    createSpaceProperty({ spaceKey, spacePropertyCreate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/property",
+            method: "POST",
+            pathParams: {
+                spaceKey,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: spacePropertyCreate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.createSpaceProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Creates a new space property. This is the same as `POST
+     * /wiki/rest/api/space/{spaceKey}/property` but the key for the property is
+     * passed as a
+     * path parameter, rather than in the request body.
+     *
+     * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
+     * ‘Admin’ permission for the space.
+     *
+     * @deprecated
+     * @returns Returned if the space property is created.
+     * @path {POST} /wiki/rest/api/space/{spaceKey}/property/{key}
+     * @scopes-current write:confluence-props
+     * @scopes-beta read:space.property:confluence, write:space.property:confluence
+     */
+    createSpacePropertyForKey({ spaceKey, key, spacePropertyCreateNoKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/property/{key}",
+            method: "POST",
+            pathParams: {
+                spaceKey,
+                key,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: spacePropertyCreateNoKey,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.createSpacePropertyForKey.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Deletes a space property.
+     *
+     * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
+     * ‘Admin’ permission for the space.
+     *
+     * @deprecated
+     * @path {DELETE} /wiki/rest/api/space/{spaceKey}/property/{key}
+     * @scopes-current write:confluence-props
+     * @scopes-beta write:space.property:confluence
+     */
+    deleteSpaceProperty({ spaceKey, key, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/property/{key}",
+            method: "DELETE",
+            pathParams: {
+                spaceKey,
+                key,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns all properties for the given space. Space properties are a key-value
+     * storage associated with a space.
+     *
+     * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’
+     * permission for the space.
+     *
+     * @deprecated
+     * @returns Returned if the requested space properties are returned.
+     * @path {GET} /wiki/rest/api/space/{spaceKey}/property
+     * @scopes-current read:confluence-props
+     * @scopes-beta read:content-details:confluence
+     */
+    getSpaceProperties({ spaceKey, expand, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/property",
+            method: "GET",
+            pathParams: {
+                spaceKey,
+            },
+            query: {
+                expand,
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpaceProperties.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Returns a space property.
+     *
+     * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’
+     * permission for the space.
+     *
+     * @deprecated
+     * @returns Returned if the requested space property is returned.
+     * @path {GET} /wiki/rest/api/space/{spaceKey}/property/{key}
+     * @scopes-current read:confluence-props
+     * @scopes-beta read:content-details:confluence
+     */
+    getSpaceProperty({ spaceKey, key, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/property/{key}",
+            method: "GET",
+            pathParams: {
+                spaceKey,
+                key,
+            },
+            query: {
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpaceProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deprecated, use [Confluence's v2
+     * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
+     *
+     * Updates a space property. Note, you cannot update the key of a space
+     * property, only the value.
+     *
+     * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
+     * ‘Admin’ permission for the space.
+     *
+     * @deprecated
+     * @returns Returned if the space property is updated.
+     * @path {PUT} /wiki/rest/api/space/{spaceKey}/property/{key}
+     * @scopes-current write:confluence-props
+     * @scopes-beta read:space.property:confluence, write:space.property:confluence
+     */
+    updateSpaceProperty({ spaceKey, key, spacePropertyUpdate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/property/{key}",
+            method: "PUT",
+            pathParams: {
+                spaceKey,
+                key,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: spacePropertyUpdate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.updateSpaceProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.getSpaceProperties.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyArray"),
+        })
+            .describe("SpacePropertiesService.getSpaceProperties.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.createSpaceProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyV1"),
+        })
+            .describe("SpacePropertiesService.createSpaceProperty.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.getSpaceProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyV1"),
+        })
+            .describe("SpacePropertiesService.getSpaceProperty.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.updateSpaceProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyV1"),
+        })
+            .describe("SpacePropertiesService.updateSpaceProperty.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.createSpacePropertyForKey.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyV1"),
+        })
+            .describe("SpacePropertiesService.createSpacePropertyForKey.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            spaceProperties_1.registerSpacePropertiesValidationSchemas,
+        ]);
+    }
+}
+exports.SpacePropertiesService = SpacePropertiesService;
+//# sourceMappingURL=SpacePropertiesService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SpacePropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SpacePropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,+DAOmC;AACnC,wEAAqE;AACrE,kBAAkB;AAClB,MAAa,sBAAuB,SAAQ,qCAAiB;IAC3D;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,CAAC,EAClB,QAAQ,EACR,mBAAmB,GAMpB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,0CAA0C;YAChD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,mBAAmB;SAC1B,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,qDAAqD,CACtD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,yBAAyB,CAAC,EACxB,QAAQ,EACR,GAAG,EACH,wBAAwB,GAQzB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,QAAQ;gBACR,GAAG;aACJ;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,wBAAwB;SAC/B,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,2DAA2D,CAC5D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAClB,QAAQ,EACR,GAAG,GAMJ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,QAAQ;gBACR,GAAG;aACJ;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,EACjB,QAAQ,EACR,MAAM,EACN,KAAK,EACL,KAAK,GAmBN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,0CAA0C;YAChD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,KAAK,EAAE;gBACL,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,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,EACf,QAAQ,EACR,GAAG,EACH,MAAM,GAcP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,QAAQ;gBACR,GAAG;aACJ;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,kDAAkD,CACnD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,EAClB,QAAQ,EACR,GAAG,EACH,mBAAmB,GAQpB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,QAAQ;gBACR,GAAG;aACJ;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,mBAAmB;SAC1B,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,qDAAqD,CACtD,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,oBAAoB,CAAC;SACzD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,qDAAqD,EACrD,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,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,kDAAkD,EAClD,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,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,kDAAkD,CAAC,CAChE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,qDAAqD,EACrD,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,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,2DAA2D,EAC3D,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,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,2DAA2D,CAAC,CACzE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,0DAAwC;SACzC,CAAC,CAAC;IACL,CAAC;CACF;AA7ZD,wDA6ZC"}