confluence.js 2.0.0 → 2.1.0

package/src/api/relation.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class Relation {
@@ -12,8 +12,8 @@ export class Relation {
    * way.
    *
    * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET
-   * https://your-domain.atlassian.net/wiki/rest/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an
-   * example custom relationship type.
+   * https://your-domain.atlassian.net/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an example
+   * custom relationship type.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.
@@ -27,8 +27,8 @@ export class Relation {
    * way.
    *
    * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET
-   * https://your-domain.atlassian.net/wiki/rest/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an
-   * example custom relationship type.
+   * https://your-domain.atlassian.net/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an example
+   * custom relationship type.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.
@@ -64,7 +64,7 @@ export class Relation {
    *
    * For example, you can use this method to find whether the current user has selected a particular page as a favorite
    * (i.e. 'save for later'): `GET
-   * https://your-domain.atlassian.net/wiki/rest/api/relation/favourite/from/user/current/to/content/123`
+   * https://your-domain.atlassian.net/api/relation/favourite/from/user/current/to/content/123`
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.
@@ -79,7 +79,7 @@ export class Relation {
    *
    * For example, you can use this method to find whether the current user has selected a particular page as a favorite
    * (i.e. 'save for later'): `GET
-   * https://your-domain.atlassian.net/wiki/rest/api/relation/favourite/from/user/current/to/content/123`
+   * https://your-domain.atlassian.net/api/relation/favourite/from/user/current/to/content/123`
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.
@@ -109,7 +109,7 @@ export class Relation {
    * default, but you can use this method to create any type of relationship between two entities.
    *
    * For example, the following method creates a 'sibling' relationship between two pieces of content: `GET
-   * https://your-domain.atlassian.net/wiki/rest/api/relation/sibling/from/content/123/to/content/456`
+   * https://your-domain.atlassian.net/api/relation/sibling/from/content/123/to/content/456`
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
@@ -123,7 +123,7 @@ export class Relation {
    * default, but you can use this method to create any type of relationship between two entities.
    *
    * For example, the following method creates a 'sibling' relationship between two pieces of content: `GET
-   * https://your-domain.atlassian.net/wiki/rest/api/relation/sibling/from/content/123/to/content/456`
+   * https://your-domain.atlassian.net/api/relation/sibling/from/content/123/to/content/456`
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
@@ -189,9 +189,8 @@ export class Relation {
    * way.
    *
    * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content
-   * with an ID of '1234': `GET
-   * https://your-domain.atlassian.net/wiki/rest/api/relation/collaborator/to/content/1234/from/user` Note,
-   * 'collaborator' is an example custom relationship type.
+   * with an ID of '1234': `GET https://your-domain.atlassian.net/api/relation/collaborator/to/content/1234/from/user`
+   * Note, 'collaborator' is an example custom relationship type.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.
@@ -205,9 +204,8 @@ export class Relation {
    * way.
    *
    * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content
-   * with an ID of '1234': `GET
-   * https://your-domain.atlassian.net/wiki/rest/api/relation/collaborator/to/content/1234/from/user` Note,
-   * 'collaborator' is an example custom relationship type.
+   * with an ID of '1234': `GET https://your-domain.atlassian.net/api/relation/collaborator/to/content/1234/from/user`
+   * Note, 'collaborator' is an example custom relationship type.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity
    * and source entity.

package/src/api/search.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class Search {
@@ -67,6 +67,9 @@ export class Search {
    * Searches for users using user-specific queries from the [Confluence Query Language
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
+   * Note that CQL input queries submitted through the `/api/search/user` endpoint only support user-specific fields
+   * like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.
+   *
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
    * profilePicture, displayName, and timeZone.
    */
@@ -78,6 +81,9 @@ export class Search {
    * Searches for users using user-specific queries from the [Confluence Query Language
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
+   * Note that CQL input queries submitted through the `/api/search/user` endpoint only support user-specific fields
+   * like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.
+   *
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
    * profilePicture, displayName, and timeZone.
    */
@@ -97,6 +103,7 @@ export class Search {
         start: parameters.start,
         limit: parameters.limit,
         expand: parameters.expand,
+        sitePermissionTypeFilter: parameters.sitePermissionTypeFilter,
       },
     };
 

package/src/api/settings.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class Settings {
@@ -180,6 +180,8 @@ export class Settings {
    * 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 Will be removed in next major version.
    */
   async setLookAndFeelSettings<T = unknown>(
     parameters: Parameters.SetLookAndFeelSettings | undefined,
@@ -190,6 +192,8 @@ export class Settings {
    * 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 Will be removed in next major version.
    */
   async setLookAndFeelSettings<T = unknown>(
     parameters?: Parameters.SetLookAndFeelSettings,

package/src/api/space.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import { paramSerializer } from '../paramSerializer';
 import type { RequestConfig } from '../requestConfig';
 
@@ -14,6 +14,8 @@ export class Space {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission). Note, the returned list will only contain spaces that the current user has
    * permission to view.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getSpaces<T = Models.SpaceArray>(
     parameters: Parameters.GetSpaces | undefined,
@@ -25,6 +27,8 @@ export class Space {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission). Note, the returned list will only contain spaces that the current user has
    * permission to view.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getSpaces<T = Models.SpaceArray>(parameters?: Parameters.GetSpaces, callback?: never): Promise<T>;
   async getSpaces<T = Models.SpaceArray>(parameters?: Parameters.GetSpaces, callback?: Callback<T>): Promise<void | T> {
@@ -68,8 +72,9 @@ export class Space {
       url: '/api/space',
       method: 'POST',
       data: {
-        key: parameters?.key,
         name: parameters?.name,
+        key: parameters?.key,
+        alias: parameters?.alias,
         description: parameters?.description,
         permissions: parameters?.permissions,
       },
@@ -105,8 +110,9 @@ export class Space {
       url: '/api/space/_private',
       method: 'POST',
       data: {
-        key: parameters?.key,
         name: parameters?.name,
+        key: parameters?.key,
+        alias: parameters?.alias,
         description: parameters?.description,
         permissions: parameters?.permissions,
       },
@@ -120,6 +126,8 @@ export class Space {
    * space.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback: Callback<T>): Promise<void>;
   /**
@@ -127,6 +135,8 @@ export class Space {
    * space.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback?: never): Promise<T>;
   async getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback?: Callback<T>): Promise<void | T> {
@@ -176,17 +186,17 @@ export class Space {
   }
 
   /**
-   * Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted
-   * yet when this method has returned. Clients should poll the status link that is returned in the response until the
-   * task completes.
+   * Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running
+   * task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status
+   * link that is returned in the response until the task completes.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
   async deleteSpace<T = Models.LongTask>(parameters: Parameters.DeleteSpace, callback: Callback<T>): Promise<void>;
   /**
-   * Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted
-   * yet when this method has returned. Clients should poll the status link that is returned in the response until the
-   * task completes.
+   * Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running
+   * task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status
+   * link that is returned in the response until the task completes.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
    */
@@ -209,6 +219,8 @@ export class Space {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
    * returned list will only contain content that the current user has permission to view.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getContentForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentForSpace,
@@ -220,6 +232,8 @@ export class Space {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
    * returned list will only contain content that the current user has permission to view.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getContentForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentForSpace,
@@ -248,6 +262,8 @@ export class Space {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
    * returned list will only contain content that the current user has permission to view.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getContentByTypeForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentByTypeForSpace,
@@ -258,6 +274,8 @@ export class Space {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
    * returned list will only contain content that the current user has permission to view.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getContentByTypeForSpace<T = Models.ContentArray>(
     parameters: Parameters.GetContentByTypeForSpace,

package/src/api/spacePermissions.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class SpacePermissions {

package/src/api/spaceProperties.ts

@@ -4,6 +4,7 @@ import type { Callback } from '../callback';
 import type { Client } from '../clients';
 import type { RequestConfig } from '../requestConfig';
 
+/** @deprecated Will be removed in next major version. */
 export class SpaceProperties {
   constructor(private client: Client) {}
 
@@ -11,6 +12,8 @@ export class SpaceProperties {
    * 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 Will be removed in next major version.
    */
   async getSpaceProperties<T = Models.SpacePropertyArray>(
     parameters: Parameters.GetSpaceProperties,
@@ -20,6 +23,8 @@ export class SpaceProperties {
    * 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 Will be removed in next major version.
    */
   async getSpaceProperties<T = Models.SpacePropertyArray>(
     parameters: Parameters.GetSpaceProperties,
@@ -46,6 +51,8 @@ export class SpaceProperties {
    * Creates a new space property.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async createSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpaceProperty,
@@ -55,6 +62,8 @@ export class SpaceProperties {
    * Creates a new space property.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async createSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpaceProperty,
@@ -81,6 +90,8 @@ export class SpaceProperties {
    * Returns a space property.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
@@ -90,6 +101,8 @@ export class SpaceProperties {
    * Returns a space property.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
@@ -115,6 +128,8 @@ export class SpaceProperties {
    * 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 Will be removed in next major version.
    */
   async createSpacePropertyForKey<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpacePropertyForKey,
@@ -125,6 +140,8 @@ export class SpaceProperties {
    * 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 Will be removed in next major version.
    */
   async createSpacePropertyForKey<T = Models.SpaceProperty>(
     parameters: Parameters.CreateSpacePropertyForKey,
@@ -149,6 +166,8 @@ export class SpaceProperties {
    * 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 Will be removed in next major version.
    */
   async updateSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.UpdateSpaceProperty,
@@ -158,6 +177,8 @@ export class SpaceProperties {
    * 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 Will be removed in next major version.
    */
   async updateSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.UpdateSpaceProperty,
@@ -183,12 +204,16 @@ export class SpaceProperties {
    * Deletes a space property.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async deleteSpaceProperty<T = void>(parameters: Parameters.DeleteSpaceProperty, callback: Callback<T>): Promise<void>;
   /**
    * Deletes a space property.
    *
    * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async deleteSpaceProperty<T = void>(parameters: Parameters.DeleteSpaceProperty, callback?: never): Promise<T>;
   async deleteSpaceProperty<T = void>(

package/src/api/spaceSettings.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class SpaceSettings {

package/src/api/template.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class Template {

package/src/api/themes.ts

@@ -1,7 +1,7 @@
 import type * as Models from './models';
 import type * as Parameters from './parameters';
-import type { Callback } from '../callback';
 import type { Client } from '../clients';
+import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export class Themes {

package/src/api/userProperties.ts

@@ -0,0 +1,185 @@
+import type * as Models from './models';
+import type * as Parameters from './parameters';
+import type { Client } from '../clients';
+import type { Callback } from '../callback';
+import type { RequestConfig } from '../requestConfig';
+
+export class UserProperties {
+  constructor(private client: Client) {}
+
+  /**
+   * 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).
+   */
+  async getUserProperties<T = Models.UserPropertyKeyArray>(
+    parameters: Parameters.GetUserProperties,
+    callback: Callback<T>,
+  ): 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).
+   */
+  async getUserProperties<T = Models.UserPropertyKeyArray>(
+    parameters: Parameters.GetUserProperties,
+    callback?: never,
+  ): Promise<T>;
+  async getUserProperties<T = Models.UserPropertyKeyArray>(
+    parameters: Parameters.GetUserProperties,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/user/${parameters.userId}/property`,
+      method: 'GET',
+      params: {
+        start: parameters.start,
+        limit: parameters.limit,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * 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).
+   */
+  async getUserProperty<T = Models.UserProperty>(
+    parameters: Parameters.GetUserProperty,
+    callback: Callback<T>,
+  ): Promise<void>;
+  /**
+   * 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).
+   */
+  async getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback?: never): Promise<T>;
+  async getUserProperty<T = Models.UserProperty>(
+    parameters: Parameters.GetUserProperty,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/user/${parameters.userId}/property/${parameters.key}`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * 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).
+   */
+  async createUserProperty<T = unknown>(
+    parameters: Parameters.CreateUserProperty,
+    callback: Callback<T>,
+  ): Promise<void>;
+  /**
+   * 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).
+   */
+  async createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback?: never): Promise<T>;
+  async createUserProperty<T = unknown>(
+    parameters: Parameters.CreateUserProperty,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/user/${parameters.userId}/property/${parameters.key}`,
+      method: 'POST',
+      data: {
+        value: parameters.value,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * 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).
+   */
+  async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback: Callback<T>): Promise<void>;
+  /**
+   * 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).
+   */
+  async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback?: never): Promise<T>;
+  async updateUserProperty<T = void>(
+    parameters: Parameters.UpdateUserProperty,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/user/${parameters.userId}/property/${parameters.key}`,
+      method: 'PUT',
+      data: {
+        value: parameters.value,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * 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).
+   */
+  async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback: Callback<T>): 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).
+   */
+  async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback?: never): Promise<T>;
+  async deleteUserProperty<T = void>(
+    parameters: Parameters.DeleteUserProperty,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/user/${parameters.userId}/property/${parameters.key}`,
+      method: 'DELETE',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+}