@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,228 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThemesService = 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 themes_1 = require("../models/themes");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class ThemesService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Returns the globally assigned theme.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
+     *
+     * @returns Returned if the global theme is returned.
+     * @path {GET} /wiki/rest/api/settings/theme/selected
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence
+     */
+    getGlobalTheme() {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/settings/theme/selected",
+            method: "GET",
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.getGlobalTheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the theme selected for a space, if one is set. If no space
+     * theme is set, this means that the space is inheriting the global look
+     * and feel settings.
+     *
+     * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’
+     * permission for the space.
+     *
+     * @returns Returned if the requested theme is returned.
+     * @path {GET} /wiki/rest/api/space/{spaceKey}/theme
+     * @scopes-current read:confluence-space.summary
+     * @scopes-beta read:space.setting:confluence
+     */
+    getSpaceTheme({ spaceKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/theme",
+            method: "GET",
+            pathParams: {
+                spaceKey,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.getSpaceTheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a theme. This includes information about the theme name,
+     * description, and icon.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
+     *
+     * @returns Returned if the requested theme is returned.
+     * @path {GET} /wiki/rest/api/settings/theme/{themeKey}
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence
+     */
+    getTheme({ themeKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/settings/theme/{themeKey}",
+            method: "GET",
+            pathParams: {
+                themeKey,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.getTheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all themes, not including the default theme.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
+     *
+     * @returns Returned if the requested themes are returned.
+     * @path {GET} /wiki/rest/api/settings/theme
+     * @scopes-current manage:confluence-configuration
+     * @scopes-beta read:configuration:confluence
+     */
+    getThemes({ start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/settings/theme",
+            method: "GET",
+            query: {
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.getThemes.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Resets the space theme. This means that the space will inherit the
+     * global look and feel settings
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @path {DELETE} /wiki/rest/api/space/{spaceKey}/theme
+     * @scopes-current write:confluence-space
+     * @scopes-beta write:space.setting:confluence
+     */
+    resetSpaceTheme({ spaceKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/theme",
+            method: "DELETE",
+            pathParams: {
+                spaceKey,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Sets the theme for a space. Note, if you want to reset the space theme to
+     * the default Confluence theme, use the 'Reset space theme' method instead
+     * of this method.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Admin' permission for the space.
+     *
+     * @returns Returned if the theme was set for the space.
+     * @path {PUT} /wiki/rest/api/space/{spaceKey}/theme
+     * @scopes-current write:confluence-space
+     * @scopes-beta read:space.setting:confluence, write:space.setting:confluence
+     */
+    setSpaceTheme({ spaceKey, themeUpdate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/theme",
+            method: "PUT",
+            pathParams: {
+                spaceKey,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: themeUpdate,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.setSpaceTheme.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ThemesService.getThemes.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("ThemeArray"),
+        })
+            .describe("ThemesService.getThemes.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ThemesService.getTheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("Theme"),
+        })
+            .describe("ThemesService.getTheme.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ThemesService.getGlobalTheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("Theme"),
+        })
+            .describe("ThemesService.getGlobalTheme.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ThemesService.getSpaceTheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("Theme"),
+        })
+            .describe("ThemesService.getSpaceTheme.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ThemesService.setSpaceTheme.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("Theme"),
+        })
+            .describe("ThemesService.setSpaceTheme.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            themes_1.registerThemesValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.ThemesService = ThemesService;
+//# sourceMappingURL=ThemesService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ThemesService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ThemesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAA+E;AAC/E,6CAI0B;AAC1B,wEAAqE;AACrE,MAAa,aAAc,SAAQ,qCAAiB;IAClD;;;;;;;;;OASG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,wCAAwC;YAC9C,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,uCAAuC,CACxC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EACZ,QAAQ,GAIT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uCAAuC;YAC7C,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,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,sCAAsC,CACvC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EACP,QAAQ,GAIT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,0CAA0C;YAChD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,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,CAAC,iCAAiC,CAAC,CACrE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,SAAS,CAAC,EACR,KAAK,EACL,KAAK,GASN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+BAA+B;YACrC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,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,CAAC,kCAAkC,CAAC,CACtE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EACd,QAAQ,GAIT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uCAAuC;YAC7C,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,QAAQ;aACT;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EACZ,QAAQ,EACR,WAAW,GAKZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uCAAuC;YAC7C,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,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,sCAAsC,CACvC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,kCAAkC,EAClC,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,YAAY,CAAC;SACjD,CAAC;aACD,QAAQ,CAAC,kCAAkC,CAAC,CAChD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iCAAiC,EACjC,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,OAAO,CAAC;SAC5C,CAAC;aACD,QAAQ,CAAC,iCAAiC,CAAC,CAC/C,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,uCAAuC,EACvC,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,OAAO,CAAC;SAC5C,CAAC;aACD,QAAQ,CAAC,uCAAuC,CAAC,CACrD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sCAAsC,EACtC,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,OAAO,CAAC;SAC5C,CAAC;aACD,QAAQ,CAAC,sCAAsC,CAAC,CACpD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sCAAsC,EACtC,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,OAAO,CAAC;SAC5C,CAAC;aACD,QAAQ,CAAC,sCAAsC,CAAC,CACpD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,wCAA+B;YAC/B,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA7TD,sCA6TC"}

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

@@ -0,0 +1,129 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type UserProperty, type UserPropertyCreate, type UserPropertyKeyArray, type UserPropertyUpdate } from "../models/userProperties";
+export declare class UserPropertiesService extends CommonHttpService {
+    /**
+     * Creates a property for a user. For more information  about user properties, see
+     * [Confluence entity properties]
+     * (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * `Note:` the number of properties which could be created per app in a tenant for
+     * each user might be
+     * restricted by fixed system limits.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {POST} /wiki/rest/api/user/{userId}/property/{key}
+     * @scopes-current write:user.property:confluence
+     */
+    createUserProperty({ userId, key, userPropertyCreate, }: {
+        /**
+         * The account ID of the user. The accountId uniquely identifies the user across
+         * all Atlassian
+         * products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+         */
+        userId: string;
+        /** The key of the user property. */
+        key: string;
+        /** The user property to be created. */
+        userPropertyCreate: UserPropertyCreate;
+    }): Promise<void>;
+    /**
+     * Deletes a property for the given user.
+     * For more information about user properties, see
+     * [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {DELETE} /wiki/rest/api/user/{userId}/property/{key}
+     * @scopes-current write:user.property:confluence
+     */
+    deleteUserProperty({ userId, key, }: {
+        /**
+         * The account ID of the user. The accountId uniquely identifies the user across
+         * all Atlassian
+         * products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+         */
+        userId: string;
+        /** The key of the user property. */
+        key: string;
+    }): Promise<void>;
+    /**
+     * Returns the properties for a user as list of property keys. For more information
+     * about user properties, see [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested properties are returned.
+     * @path {GET} /wiki/rest/api/user/{userId}/property
+     * @scopes-current read:user.property:confluence
+     */
+    getUserProperties({ userId, start, limit, }: {
+        /** The account ID of the user to be queried for its properties. */
+        userId: string;
+        /** The starting index of the returned properties. */
+        start?: number;
+        /**
+         * The maximum number of properties to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<UserPropertyKeyArray>;
+    /**
+     * Returns the property corresponding to `key` for a user. For more information
+     * about user properties, see [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested properties are returned.
+     * @path {GET} /wiki/rest/api/user/{userId}/property/{key}
+     * @scopes-current read:user.property:confluence
+     */
+    getUserProperty({ userId, key, }: {
+        /** The account ID of the user to be queried for its properties. */
+        userId: string;
+        /** The key of the user property. */
+        key: string;
+    }): Promise<UserProperty>;
+    /**
+     * Updates a property for the given user. Note, you cannot update the key of a
+     * user property, only the value.
+     * For more information about user properties, see
+     * [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {PUT} /wiki/rest/api/user/{userId}/property/{key}
+     * @scopes-current write:user.property:confluence
+     */
+    updateUserProperty({ userId, key, userPropertyUpdate, }: {
+        /**
+         * The account ID of the user. The accountId uniquely identifies the user across
+         * all Atlassian
+         * products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+         */
+        userId: string;
+        /** The key of the user property. */
+        key: string;
+        /** The user property to be updated. */
+        userPropertyUpdate: UserPropertyUpdate;
+    }): Promise<void>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,192 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserPropertiesService = 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 userProperties_1 = require("../models/userProperties");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class UserPropertiesService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Creates a property for a user. For more information  about user properties, see
+     * [Confluence entity properties]
+     * (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * `Note:` the number of properties which could be created per app in a tenant for
+     * each user might be
+     * restricted by fixed system limits.
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {POST} /wiki/rest/api/user/{userId}/property/{key}
+     * @scopes-current write:user.property:confluence
+     */
+    createUserProperty({ userId, key, userPropertyCreate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/{userId}/property/{key}",
+            method: "POST",
+            pathParams: {
+                userId,
+                key,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: userPropertyCreate,
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Deletes a property for the given user.
+     * For more information about user properties, see
+     * [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {DELETE} /wiki/rest/api/user/{userId}/property/{key}
+     * @scopes-current write:user.property:confluence
+     */
+    deleteUserProperty({ userId, key, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/{userId}/property/{key}",
+            method: "DELETE",
+            pathParams: {
+                userId,
+                key,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns the properties for a user as list of property keys. For more information
+     * about user properties, see [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested properties are returned.
+     * @path {GET} /wiki/rest/api/user/{userId}/property
+     * @scopes-current read:user.property:confluence
+     */
+    getUserProperties({ userId, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/{userId}/property",
+            method: "GET",
+            pathParams: {
+                userId,
+            },
+            query: {
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserPropertiesService.getUserProperties.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the property corresponding to `key` for a user. For more information
+     * about user properties, see [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested properties are returned.
+     * @path {GET} /wiki/rest/api/user/{userId}/property/{key}
+     * @scopes-current read:user.property:confluence
+     */
+    getUserProperty({ userId, key, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/{userId}/property/{key}",
+            method: "GET",
+            pathParams: {
+                userId,
+                key,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserPropertiesService.getUserProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates a property for the given user. Note, you cannot update the key of a
+     * user property, only the value.
+     * For more information about user properties, see
+     * [Confluence entity
+     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+     * `Note`, these properties stored against a user are on a Confluence site level
+     * and not space/content level.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {PUT} /wiki/rest/api/user/{userId}/property/{key}
+     * @scopes-current write:user.property:confluence
+     */
+    updateUserProperty({ userId, key, userPropertyUpdate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/user/{userId}/property/{key}",
+            method: "PUT",
+            pathParams: {
+                userId,
+                key,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: userPropertyUpdate,
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("UserPropertiesService.getUserProperties.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("UserPropertyKeyArray"),
+        })
+            .describe("UserPropertiesService.getUserProperties.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("UserPropertiesService.getUserProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("UserProperty"),
+        })
+            .describe("UserPropertiesService.getUserProperty.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            userProperties_1.registerUserPropertiesValidationSchemas,
+        ]);
+    }
+}
+exports.UserPropertiesService = UserPropertiesService;
+//# sourceMappingURL=UserPropertiesService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UserPropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/UserPropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6DAMkC;AAClC,wEAAqE;AACrE,MAAa,qBAAsB,SAAQ,qCAAiB;IAC1D;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,EACjB,MAAM,EACN,GAAG,EACH,kBAAkB,GAYnB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,MAAM;gBACN,GAAG;aACJ;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,kBAAkB;SACzB,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,EACjB,MAAM,EACN,GAAG,GAUJ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,MAAM;gBACN,GAAG;aACJ;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAChB,MAAM,EACN,KAAK,EACL,KAAK,GAWN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uCAAuC;YAC7C,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,MAAM;aACP;YACD,KAAK,EAAE;gBACL,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,kDAAkD,CACnD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EACd,MAAM,EACN,GAAG,GAMJ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,MAAM;gBACN,GAAG;aACJ;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,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAAC,EACjB,MAAM,EACN,GAAG,EACH,kBAAkB,GAYnB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,MAAM;gBACN,GAAG;aACJ;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,kBAAkB;SACzB,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,CAAC,UAAU;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,sBAAsB,CAAC;SAC3D,CAAC;aACD,QAAQ,CAAC,kDAAkD,CAAC,CAChE,CAAC;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,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,wDAAuC;SACxC,CAAC,CAAC;IACL,CAAC;CACF;AAhRD,sDAgRC"}