@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,249 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsService = 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 settings_1 = require("../models/settings");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class SettingsService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Returns the look and feel settings for the site or a single space. This
+     * includes attributes such as the color scheme, padding, and border radius.
+     *
+     * The look and feel settings for a space can be inherited from the global
+     * look and feel settings or provided by a theme.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * None
+     *
+     * @returns Returned if the requested look and feel settings are returned.
+     * @path {GET} /wiki/rest/api/settings/lookandfeel
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence, read:space.setting:confluence
+     */
+    getLookAndFeelSettings({ spaceKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/settings/lookandfeel",
+            method: "GET",
+            query: {
+                spaceKey,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.getLookAndFeelSettings.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the system information for the Confluence Cloud tenant. This
+     * information is used by Atlassian.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the system information for the Confluence Cloud tenant
+     * is returned.
+     * @path {GET} /wiki/rest/api/settings/systemInfo
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence
+     */
+    getSystemInfo() {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/settings/systemInfo",
+            method: "GET",
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.getSystemInfo.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Resets the custom look and feel settings for the site or a single space.
+     * This changes the values of the custom settings to be the same as the
+     * default settings. It does not change which settings (default or custom)
+     * are selected. Note, the default space settings are inherited from the
+     * current global settings.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @path {DELETE} /wiki/rest/api/settings/lookandfeel/custom
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta write:configuration:confluence, write:space.setting:confluence
+     */
+    resetLookAndFeelSettings({ spaceKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/settings/lookandfeel/custom",
+            method: "DELETE",
+            query: {
+                spaceKey,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Sets the look and feel settings to either the default settings or the
+     * custom settings, for the site or a single space. Note, the default
+     * space settings are inherited from the current global settings.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @deprecated
+     * @returns Returned if the look and feel settings were set.
+     * @path {PUT} /wiki/rest/api/settings/lookandfeel/selected
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence, read:space.setting:confluence,
+     * write:configuration:confluence, write:space.setting:confluence
+     */
+    setLookAndFeelSettings({ spaceKey, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/settings/lookandfeel/selected",
+            method: "PUT",
+            query: {
+                spaceKey,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.setLookAndFeelSettings.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Sets the look and feel settings to the default (global) settings, the
+     * custom settings, or the current theme's settings for a space.
+     * The custom and theme settings can only be selected if there is already
+     * a theme set for a space. Note, the default space settings are inherited
+     * from the current global settings.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the look and feel settings were set.
+     * @path {PUT} /wiki/rest/api/settings/lookandfeel
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:space.setting:confluence, write:space.setting:confluence
+     */
+    updateLookAndFeel({ lookAndFeelSelection, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/settings/lookandfeel",
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: lookAndFeelSelection,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.updateLookAndFeel.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates the look and feel settings for the site or for a single space.
+     * If custom settings exist, they are updated. If no custom settings exist,
+     * then a set of custom settings is created.
+     *
+     * Note, if a theme is selected for a space, the space look and feel settings
+     * are provided by the theme and cannot be overridden.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the look and feel settings are updated.
+     * @path {POST} /wiki/rest/api/settings/lookandfeel/custom
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence, read:space.setting:confluence,
+     * write:configuration:confluence, write:space.setting:confluence
+     */
+    updateLookAndFeelSettings({ spaceKey, lookAndFeel, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/settings/lookandfeel/custom",
+            method: "POST",
+            query: {
+                spaceKey,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: lookAndFeel,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.updateLookAndFeelSettings.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SettingsService.getLookAndFeelSettings.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("LookAndFeelSettings"),
+        })
+            .describe("SettingsService.getLookAndFeelSettings.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SettingsService.updateLookAndFeel.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("LookAndFeelSelection"),
+        })
+            .describe("SettingsService.updateLookAndFeel.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SettingsService.updateLookAndFeelSettings.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("LookAndFeelWithLinks"),
+        })
+            .describe("SettingsService.updateLookAndFeelSettings.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SettingsService.setLookAndFeelSettings.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.string(),
+        })
+            .describe("SettingsService.setLookAndFeelSettings.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SettingsService.getSystemInfo.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("SystemInfoEntity")),
+        })
+            .describe("SettingsService.getSystemInfo.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([settings_1.registerSettingsValidationSchemas]);
+    }
+}
+exports.SettingsService = SettingsService;
+//# sourceMappingURL=SettingsService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SettingsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAE9D,iDAM4B;AAC5B,wEAAqE;AACrE,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;;;;;;;;;;;;;;OAcG;IACH,sBAAsB,CAAC,EACrB,QAAQ,GAQT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,qCAAqC;YAC3C,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,QAAQ;aACT;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,iDAAiD,CAClD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oCAAoC;YAC1C,MAAM,EAAE,KAAK;SACd,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,wCAAwC,CACzC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EACvB,QAAQ,GAQT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE;gBACL,QAAQ;aACT;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,sBAAsB,CAAC,EACrB,QAAQ,EACR,WAAW,GAUZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8CAA8C;YACpD,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,QAAQ;aACT;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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,iDAAiD,CAClD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,EAChB,oBAAoB,GAIrB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,qCAAqC;YAC3C,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,oBAAoB;SAC3B,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,4CAA4C,CAC7C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACH,yBAAyB,CAAC,EACxB,QAAQ,EACR,WAAW,GAiBZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,MAAM;YACd,KAAK,EAAE;gBACL,QAAQ;aACT;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,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,iDAAiD,EACjD,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,qBAAqB,CAAC;SAC1D,CAAC;aACD,QAAQ,CAAC,iDAAiD,CAAC,CAC/D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,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,4CAA4C,CAAC,CAC1D,CAAC;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,sBAAsB,CAAC;SAC3D,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iDAAiD,EACjD,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,MAAM,EAAE;SACjB,CAAC;aACD,QAAQ,CAAC,iDAAiD,CAAC,CAC/D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,wCAAwC,EACxC,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,kBAAkB,CAAC,CAAC;SACnE,CAAC;aACD,QAAQ,CAAC,wCAAwC,CAAC,CACtD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AA5WD,0CA4WC"}

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

@@ -0,0 +1,68 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type SpacePermissionCustomContent, type SpacePermissionRequest, type SpacePermissionV2 } from "../models/spacePermissions";
+export declare class SpacePermissionsService extends CommonHttpService {
+    /**
+     * Adds new custom content permission to space.
+     *
+     * If the permission to be added is a group permission, the group can be identified
+     * by its group name or group id.
+     *
+     * Note: Only apps can access this REST resource and only make changes to the
+     * respective app permissions.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @path {POST} /wiki/rest/api/space/{spaceKey}/permission/custom-content
+     * @scopes-current read:space.permission:confluence, write:space.permission:confluence
+     */
+    addCustomContentPermissions({ spaceKey, spacePermissionCustomContent, }: {
+        /** The key of the space to be queried for its content. */
+        spaceKey: string;
+        /** The permissions to be created. */
+        spacePermissionCustomContent: SpacePermissionCustomContent;
+    }): Promise<void>;
+    /**
+     * Adds new permission to space.
+     *
+     * If the permission to be added is a group permission, the group can be identified
+     * by its group name or group id.
+     *
+     * Note: Apps cannot access this REST resource - including when utilizing user
+     * impersonation.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the requested content is returned.
+     * @path {POST} /wiki/rest/api/space/{spaceKey}/permission
+     * @scopes-current read:space.permission:confluence, write:space.permission:confluence
+     */
+    addPermissionToSpace({ spaceKey, spacePermissionRequest, }: {
+        /** The key of the space to be queried for its content. */
+        spaceKey: string;
+        /** The permission to be created. */
+        spacePermissionRequest: SpacePermissionRequest;
+    }): Promise<SpacePermissionV2>;
+    /**
+     * Removes a space permission. Note that removing Read Space permission for a user
+     * or group will remove all
+     * the space permissions for that user or group.
+     *
+     * Note: Apps cannot access this REST resource - including when utilizing user
+     * impersonation.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @path {DELETE} /wiki/rest/api/space/{spaceKey}/permission/{id}
+     * @scopes-current write:space.permission:confluence
+     */
+    removePermission({ spaceKey, id, }: {
+        /** The key of the space to be queried for its content. */
+        spaceKey: string;
+        /** Id of the permission to be deleted. */
+        id: number;
+    }): Promise<void>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpacePermissionsService = 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 spacePermissions_1 = require("../models/spacePermissions");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class SpacePermissionsService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Adds new custom content permission to space.
+     *
+     * If the permission to be added is a group permission, the group can be identified
+     * by its group name or group id.
+     *
+     * Note: Only apps can access this REST resource and only make changes to the
+     * respective app permissions.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @path {POST} /wiki/rest/api/space/{spaceKey}/permission/custom-content
+     * @scopes-current read:space.permission:confluence, write:space.permission:confluence
+     */
+    addCustomContentPermissions({ spaceKey, spacePermissionCustomContent, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/permission/custom-content",
+            method: "POST",
+            pathParams: {
+                spaceKey,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: spacePermissionCustomContent,
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Adds new permission to space.
+     *
+     * If the permission to be added is a group permission, the group can be identified
+     * by its group name or group id.
+     *
+     * Note: Apps cannot access this REST resource - including when utilizing user
+     * impersonation.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the requested content is returned.
+     * @path {POST} /wiki/rest/api/space/{spaceKey}/permission
+     * @scopes-current read:space.permission:confluence, write:space.permission:confluence
+     */
+    addPermissionToSpace({ spaceKey, spacePermissionRequest, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/permission",
+            method: "POST",
+            pathParams: {
+                spaceKey,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: spacePermissionRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePermissionsService.addPermissionToSpace.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Removes a space permission. Note that removing Read Space permission for a user
+     * or group will remove all
+     * the space permissions for that user or group.
+     *
+     * Note: Apps cannot access this REST resource - including when utilizing user
+     * impersonation.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @path {DELETE} /wiki/rest/api/space/{spaceKey}/permission/{id}
+     * @scopes-current write:space.permission:confluence
+     */
+    removePermission({ spaceKey, id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/permission/{id}",
+            method: "DELETE",
+            pathParams: {
+                spaceKey,
+                id,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePermissionsService.addPermissionToSpace.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePermissionV2"),
+        })
+            .describe("SpacePermissionsService.addPermissionToSpace.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            spacePermissions_1.registerSpacePermissionsValidationSchemas,
+        ]);
+    }
+}
+exports.SpacePermissionsService = SpacePermissionsService;
+//# sourceMappingURL=SpacePermissionsService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SpacePermissionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SpacePermissionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iEAKoC;AACpC,wEAAqE;AACrE,MAAa,uBAAwB,SAAQ,qCAAiB;IAC5D;;;;;;;;;;;;;;OAcG;IACH,2BAA2B,CAAC,EAC1B,QAAQ,EACR,4BAA4B,GAM7B;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2DAA2D;YACjE,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,4BAA4B;SACnC,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAAC,EACnB,QAAQ,EACR,sBAAsB,GAMvB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4CAA4C;YAClD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,sBAAsB;SAC7B,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;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CAAC,EACf,QAAQ,EACR,EAAE,GAMH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iDAAiD;YACvD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,QAAQ;gBACR,EAAE;aACH;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,CAAC,UAAU;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,iDAAuB,CAAC,IAAI,CAAC,mBAAmB,CAAC;SACxD,CAAC;aACD,QAAQ,CAAC,uDAAuD,CAAC,CACrE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,4DAAyC;SAC1C,CAAC,CAAC;IACL,CAAC;CACF;AAlJD,0DAkJC"}

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

@@ -0,0 +1,161 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type SpacePropertyArray, type SpacePropertyCreate, type SpacePropertyCreateNoKey, type SpacePropertyUpdate, type SpacePropertyV1 } from "../models/spaceProperties";
+/** @deprecated */
+export declare class SpacePropertiesService extends 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, }: {
+        /** The key of the space that the property will be created in. */
+        spaceKey: string;
+        /** The space property to be created. */
+        spacePropertyCreate: SpacePropertyCreate;
+    }): Promise<SpacePropertyV1>;
+    /**
+     * 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, }: {
+        /** The key of the space that the property will be created in. */
+        spaceKey: string;
+        /** The key of the property to be created. */
+        key: string;
+        /** The space property to be created. */
+        spacePropertyCreateNoKey: SpacePropertyCreateNoKey;
+    }): Promise<SpacePropertyV1>;
+    /**
+     * 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, }: {
+        /** The key of the space that the property is in. */
+        spaceKey: string;
+        /** The key of the property to be deleted. */
+        key: string;
+    }): Promise<void>;
+    /**
+     * 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, }: {
+        /** The key of the space to be queried for its properties. */
+        spaceKey: string;
+        /**
+         * A multi-value parameter indicating which properties of the space
+         * property to expand. By default, the `version` object is expanded.
+         *
+         * - `version` returns information about the version of the content.
+         * - `space` returns the space that the properties are in.
+         */
+        expand?: ("version" | "space")[];
+        /** The starting index of the returned objects. */
+        start?: number;
+        /**
+         * The maximum number of properties to return per page. Note, this may be
+         * restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<SpacePropertyArray>;
+    /**
+     * 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, }: {
+        /** The key of the space that the property is in. */
+        spaceKey: string;
+        /** The key of the space property. */
+        key: string;
+        /**
+         * A multi-value parameter indicating which properties of the space
+         * property to expand. By default, the `version` object is expanded.
+         *
+         * - `version` returns information about the version of the content.
+         * - `space` returns the space that the properties are in.
+         */
+        expand?: ("version" | "space")[];
+    }): Promise<SpacePropertyV1>;
+    /**
+     * 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, }: {
+        /** The key of the space that the property is in. */
+        spaceKey: string;
+        /** The key of the property to be updated. */
+        key: string;
+        /** The space property being updated. */
+        spacePropertyUpdate: SpacePropertyUpdate;
+    }): Promise<SpacePropertyV1>;
+    static initialize(): void;
+}