confluence.js 2.0.0-dev20250512202536 → 2.1.0

package/src/api/group.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 Group {
@@ -72,12 +72,16 @@ export class Group {
    * Delete user group.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback: Callback<T>): Promise<void>;
   /**
    * Delete user group.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback?: never): Promise<T>;
   async removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback?: Callback<T>): Promise<void | T> {
@@ -97,6 +101,8 @@ export class Group {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getGroupByQueryParam<T = Models.Group>(
     parameters: Parameters.GetGroupByQueryParam,
@@ -107,6 +113,8 @@ export class Group {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getGroupByQueryParam<T = Models.Group>(
     parameters: Parameters.GetGroupByQueryParam,
@@ -164,14 +172,14 @@ export class Group {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
    */
-  async removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback: Callback<T>): Promise<void>;
+  async removeGroupById<T = void>(parameters: Parameters.DeleteGroupById, callback: Callback<T>): Promise<void>;
   /**
    * Delete user group.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
    */
-  async removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback?: never): Promise<T>;
-  async removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback?: Callback<T>): Promise<void | T> {
+  async removeGroupById<T = void>(parameters: Parameters.DeleteGroupById, callback?: never): Promise<T>;
+  async removeGroupById<T = void>(parameters: Parameters.DeleteGroupById, callback?: Callback<T>): Promise<void | T> {
     const config: RequestConfig = {
       url: '/api/group/by-id',
       method: 'DELETE',
@@ -190,6 +198,8 @@ export class Group {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback: Callback<T>): Promise<void>;
   /**
@@ -199,6 +209,8 @@ export class Group {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback?: never): Promise<T>;
   async getGroupByName<T = Models.Group>(
@@ -218,6 +230,8 @@ export class Group {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getMembersByQueryParam<T = Models.UserArray>(
     parameters: Parameters.GetMembersByQueryParam,
@@ -228,6 +242,8 @@ export class Group {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getMembersByQueryParam<T = Models.UserArray>(
     parameters: Parameters.GetMembersByQueryParam,
@@ -251,6 +267,31 @@ export class Group {
     return this.client.sendRequest(config, callback);
   }
 
+  /** Get search results of groups by partial query provided. */
+  async searchGroups<T = Models.GroupArrayWithLinks>(
+    parameters: Parameters.SearchGroups,
+    callback: Callback<T>,
+  ): Promise<void>;
+  /** Get search results of groups by partial query provided. */
+  async searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;
+  async searchGroups<T = Models.GroupArrayWithLinks>(
+    parameters: Parameters.SearchGroups,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: '/api/group/picker',
+      method: 'GET',
+      params: {
+        query: parameters.query,
+        start: parameters.start,
+        limit: parameters.limit,
+        shouldReturnTotalSize: parameters.shouldReturnTotalSize,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
   /**
    * Returns the users that are members of a group.
    *
@@ -259,8 +300,8 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembers<T = Models.UserArray>(
-    parameters: Parameters.GetGroupMembers,
+  async getGroupMembersByGroupId<T = Models.UserArray>(
+    parameters: Parameters.GetGroupMembersByGroupId,
     callback: Callback<T>,
   ): Promise<void>;
   /**
@@ -271,42 +312,22 @@ export class Group {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback?: never): Promise<T>;
-  async getGroupMembers<T = Models.UserArray>(
-    parameters: Parameters.GetGroupMembers,
-    callback?: Callback<T>,
-  ): Promise<void | T> {
-    const config: RequestConfig = {
-      url: `/api/group/${parameters.groupName}/member`,
-      method: 'GET',
-      params: {
-        start: parameters.start,
-        limit: parameters.limit,
-      },
-    };
-
-    return this.client.sendRequest(config, callback);
-  }
-
-  /** Get search results of groups by partial query provided. */
-  async searchGroups<T = Models.GroupArrayWithLinks>(
-    parameters: Parameters.SearchGroups,
-    callback: Callback<T>,
-  ): Promise<void>;
-  /** Get search results of groups by partial query provided. */
-  async searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;
-  async searchGroups<T = Models.GroupArrayWithLinks>(
-    parameters: Parameters.SearchGroups,
+  async getGroupMembersByGroupId<T = Models.UserArray>(
+    parameters: Parameters.GetGroupMembersByGroupId,
+    callback?: never,
+  ): Promise<T>;
+  async getGroupMembersByGroupId<T = Models.UserArray>(
+    parameters: Parameters.GetGroupMembersByGroupId,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
-      url: '/api/group/picker',
+      url: `/api/group/${parameters.groupId}/membersByGroupId`,
       method: 'GET',
       params: {
-        query: parameters.query,
         start: parameters.start,
         limit: parameters.limit,
         shouldReturnTotalSize: parameters.shouldReturnTotalSize,
+        expand: parameters.expand,
       },
     };
 
@@ -383,47 +404,6 @@ export class Group {
     return this.client.sendRequest(config, callback);
   }
 
-  /**
-   * Returns the users that are members of a group.
-   *
-   * Use updated Get group API
-   *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
-   * ('Can use' global permission).
-   */
-  async getGroupMembersByGroupId<T = Models.UserArray>(
-    parameters: Parameters.GetGroupMembersByGroupId,
-    callback: Callback<T>,
-  ): Promise<void>;
-  /**
-   * Returns the users that are members of a group.
-   *
-   * Use updated Get group API
-   *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
-   * ('Can use' global permission).
-   */
-  async getGroupMembersByGroupId<T = Models.UserArray>(
-    parameters: Parameters.GetGroupMembersByGroupId,
-    callback?: never,
-  ): Promise<T>;
-  async getGroupMembersByGroupId<T = Models.UserArray>(
-    parameters: Parameters.GetGroupMembersByGroupId,
-    callback?: Callback<T>,
-  ): Promise<void | T> {
-    const config: RequestConfig = {
-      url: `/api/group/${parameters.groupId}/membersByGroupId`,
-      method: 'GET',
-      params: {
-        start: parameters.start,
-        limit: parameters.limit,
-        shouldReturnTotalSize: parameters.shouldReturnTotalSize,
-      },
-    };
-
-    return this.client.sendRequest(config, callback);
-  }
-
   /**
    * Adds a user as a member in a group.
    *
@@ -481,4 +461,45 @@ export class Group {
 
     return this.client.sendRequest(config, callback);
   }
+
+  /**
+   * Returns the users that are members of a group.
+   *
+   * Use updated Get group API
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   *
+   * @deprecated Will be removed in next major version. Use `group.getGroupMembersByGroupId`
+   */
+  async getGroupMembers<T = Models.UserArray>(
+    parameters: Parameters.GetGroupMembers,
+    callback: Callback<T>,
+  ): Promise<void>;
+  /**
+   * Returns the users that are members of a group.
+   *
+   * Use updated Get group API
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
+   * ('Can use' global permission).
+   *
+   * @deprecated Will be removed in next major version. Use `group.getGroupMembersByGroupId`
+   */
+  async getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback?: never): Promise<T>;
+  async getGroupMembers<T = Models.UserArray>(
+    parameters: Parameters.GetGroupMembers,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/group/${parameters.groupName}/member`,
+      method: 'GET',
+      params: {
+        start: parameters.start,
+        limit: parameters.limit,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
 }

package/src/api/index.ts

@@ -29,3 +29,4 @@ export * from './spaceSettings';
 export * from './template';
 export * from './themes';
 export * from './users';
+export * from './userProperties';

package/src/api/inlineTasks.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 InlineTasks {
   constructor(private client: Client) {}
 
@@ -12,6 +13,8 @@ export class InlineTasks {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async searchTasks<T = Models.TaskPageResponse>(
     parameters: Parameters.SearchTasks | undefined,
@@ -22,6 +25,8 @@ export class InlineTasks {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async searchTasks<T = Models.TaskPageResponse>(parameters?: Parameters.SearchTasks, callback?: never): Promise<T>;
   async searchTasks<T = Models.TaskPageResponse>(
@@ -57,6 +62,8 @@ export class InlineTasks {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated
    * with the task.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback: Callback<T>): Promise<void>;
   /**
@@ -64,6 +71,8 @@ export class InlineTasks {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated
    * with the task.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: never): Promise<T>;
   async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: Callback<T>): Promise<void | T> {
@@ -80,6 +89,8 @@ export class InlineTasks {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated
    * with the task.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback: Callback<T>): Promise<void>;
   /**
@@ -87,6 +98,8 @@ export class InlineTasks {
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated
    * with the task.
+   *
+   * @deprecated Will be removed in next major version.
    */
   async updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback?: never): Promise<T>;
   async updateTaskById<T = Models.Task>(

package/src/api/labelInfo.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 LabelInfo {

package/src/api/longRunningTask.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 LongRunningTask {
@@ -34,6 +34,7 @@ export class LongRunningTask {
       url: '/api/longtask',
       method: 'GET',
       params: {
+        key: parameters?.key,
         start: parameters?.start,
         limit: parameters?.limit,
       },

package/src/api/models/spaceCreate.ts

@@ -3,10 +3,19 @@ import type { SpacePermission } from './spacePermission';
 
 /** This is the request object used when creating a new space. */
 export interface SpaceCreate {
-  /** The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). */
-  key: string;
   /** The name of the new space. */
   name: string;
+  /**
+   * The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). If `alias` is not
+   * provided, this is required.
+   */
+  key?: string;
+  /**
+   * This field will be used as the new identifier for the space in confluence page URLs. If the property is not
+   * provided the alias will be the provided key. This property is experimental and may be changed or removed in the
+   * future.
+   */
+  alias?: string;
   description?: SpaceDescriptionCreate;
   /**
    * The permissions for the new space. If no permissions are provided, the [Confluence default space

package/src/api/models/spacePrivateCreate.ts

@@ -3,10 +3,19 @@ import type { SpacePermissionCreate } from './spacePermissionCreate';
 
 /** This is the request object used when creating a new private space. */
 export interface SpacePrivateCreate {
-  /** The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). */
-  key: string;
   /** The name of the new space. */
   name: string;
+  /**
+   * The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). If `alias` is not
+   * provided, this is required.
+   */
+  key?: string;
+  /**
+   * This field will be used as the new identifier for the space in confluence page URLs. If the property is not
+   * provided the alias will be the provided key. This property is experimental and may be changed or removed in the
+   * future.
+   */
+  alias?: string;
   description?: SpaceDescriptionCreate;
   /**
    * The permissions for the new space. If no permissions are provided, the [Confluence default space

package/src/api/parameters/bulkAsyncConvertContentBodyRequest.ts

@@ -0,0 +1,88 @@
+import type { OneOrMany } from '../../interfaces';
+
+export interface BulkAsyncConvertContentBodyRequest {
+  /** The name of the target format for the content body conversion. */
+  to: string;
+  /** This object is used when creating or updating content. */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  body: Record<string, any> & {
+    /** The body of the content in the relevant format. */
+    value: string;
+    /** The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. */
+    representation:
+      | 'view'
+      | 'export_view'
+      | 'styled_view'
+      | 'storage'
+      | 'editor'
+      | 'editor2'
+      | 'anonymous_export_view'
+      | 'wiki'
+      | 'atlas_doc_format'
+      | 'plain'
+      | 'raw'
+      | string;
+  };
+  /**
+   * A multi-value, comma-separated parameter indicating which properties of the content to expand and populate. Expands
+   * are dependent on the `to` conversion format and may be irrelevant for certain conversions (e.g.
+   * `macroRenderedOutput` is redundant when converting to `view` format).
+   *
+   * If rendering to `view` format, and the body content being converted includes arbitrary nested content (such as
+   * macros); then it is necessary to include webresource expands in the request. Webresources for content body are the
+   * batched JS and CSS dependencies for any nested dynamic content (i.e. macros).
+   */
+  expand?: OneOrMany<
+    | 'embeddedContent'
+    | 'mediaToken'
+    | 'macroRenderedOutput'
+    | 'webresource.superbatch.uris.js'
+    | 'webresource.superbatch.uris.css'
+    | 'webresource.superbatch.uris.all'
+    | 'webresource.superbatch.tags.all'
+    | 'webresource.superbatch.tags.css'
+    | 'webresource.superbatch.tags.js'
+    | 'webresource.uris.js'
+    | 'webresource.uris.css'
+    | 'webresource.uris.all'
+    | 'webresource.tags.all'
+    | 'webresource.tags.css'
+    | 'webresource.tags.js'
+  >;
+  /**
+   * Mode used for rendering embedded content, such as attachments.
+   *
+   * - `current` renders the embedded content using the latest version.
+   * - `version-at-save renders` the embedded content using the version at the time of save.
+   *
+   * @default current
+   */
+  embeddedContentRender?: 'current' | 'version-at-save' | string;
+  /**
+   * The content ID used to find the space for resolving embedded content (page includes, files, and links) in the
+   * content body. For example, if the source content contains the link
+   *
+   * `<ac:link><ri:page ri:content-title="Example page" /><ac:link>` and the `contentIdContext=123` parameter is
+   * provided, then the link will be converted into a link to the "Example page" page in the same space that has the
+   * content with ID=123. Note that `spaceKeyContext` will be ignored if this parameter is provided.
+   */
+  contentIdContext?: string;
+  /**
+   * The space key used for resolving embedded content (page includes, files, and links) in the content body. For
+   * example, if the source content contains the link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>`
+   * and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted into a link to the "Example
+   * page" page in the "TEST" space.
+   */
+  spaceKeyContext?: string;
+  /**
+   * If `false`, the cache will erase its current value and begin a new conversion. If `true`, the cache will not erase
+   * its current value, and will set the status of the async conversion to “RERUNNING”. Once the data is updated, the
+   * status will change to “COMPLETED”. Large macros that take a long time to convert and that need not be immediately
+   * up to date (e.g. a macro in which the new conversion result is the same as a previous conversion result that was
+   * completed within the last 5 minutes) should set this field to `true`. Cache values are stored per user per content
+   * body and expansions.
+   *
+   * @default false
+   */
+  allowCache?: boolean;
+}

package/src/api/parameters/bulkAsyncConvertContentBodyResponse.ts

@@ -0,0 +1,4 @@
+export interface BulkAsyncConvertContentBodyResponse {
+  /** The asyncIds of the conversion tasks. */
+  ids: string[];
+}

package/src/api/parameters/deleteGroupById.ts

@@ -0,0 +1,4 @@
+export interface DeleteGroupById {
+  /** Id of the group to delete. */
+  id: string;
+}

package/src/api/parameters/downloadAttachment.ts

@@ -8,4 +8,10 @@ export interface DownloadAttachment {
    * the attachment.
    */
   version?: number;
+  /**
+   * The statuses allowed on the retrieved attachment. If this parameter is absent, it will default to `current`.
+   *
+   * @default current
+   */
+  status?: string | string[];
 }

package/src/api/parameters/getContentChildren.ts

@@ -1,3 +1,5 @@
+import type { OneOrMany } from '../../interfaces';
+
 export interface GetContentChildren {
   /** The ID of the content to be queried for its children. */
   id: string;
@@ -9,7 +11,11 @@ export interface GetContentChildren {
    * - `page` returns all child pages of the content.
    * - Custom content types that are provided by apps are also supported.
    */
-  expand?: string[];
+  expand?: OneOrMany<'attachment' | 'comments' | 'page' | string>;
   /** The version of the parent content to retrieve children for. Currently, this only works for the latest version. */
   parentVersion?: number;
+  /** The starting index of the returned content children. */
+  start?: number;
+  /** The maximum number of content children to return per page. */
+  limit?: number;
 }

package/src/api/parameters/getContentsWithState.ts

@@ -0,0 +1,17 @@
+export interface GetContentsWithState {
+  /** The key of the space to be queried for its content state settings. */
+  spaceKey: string;
+  /** The id of the content state to filter content by */
+  stateId: number;
+  /**
+   * A multi-value parameter indicating which properties of the content to expand. Options include: space, version,
+   * history, children, etc.
+   *
+   *     Ex: (space, version);
+   */
+  expand?: string[];
+  /** Maximum number of results to return */
+  limit?: number;
+  /** Number of result to start returning. (0 indexed) */
+  start?: number;
+}

package/src/api/parameters/getGroupMembersByGroupId.ts

@@ -10,4 +10,11 @@ export interface GetGroupMembersByGroupId {
    * operation; use it if your use case needs this value.
    */
   shouldReturnTotalSize?: boolean;
+  /**
+   * A multi-value parameter indicating which properties of the user to expand.
+   *
+   * - `operations` returns the operations that the user is allowed to do.
+   * - `personalSpace` returns the user's personal space, if it exists.
+   */
+  expand?: 'operations' | 'personalSpace' | string | ('operations' | 'personalSpace' | string)[];
 }

package/src/api/parameters/getGroupMembershipsForUser.ts

@@ -2,11 +2,15 @@ export interface GetGroupMembershipsForUser {
   /**
    * This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
    * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+   *
+   * @deprecated Will be removed in next major version.
    */
   key?: string;
   /**
    * This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
    * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+   *
+   * @deprecated Will be removed in next major version.
    */
   username?: string;
   /**

package/src/api/parameters/getTasks.ts

@@ -1,4 +1,6 @@
 export interface GetTasks {
+  /** The key of the tasks. */
+  key?: string;
   /** The starting index of the returned tasks. */
   start?: number;
   /** The maximum number of tasks to return per page. Note, this may be restricted by fixed system limits. */

package/src/api/parameters/getUser.ts

@@ -2,11 +2,15 @@ export interface GetUser {
   /**
    * This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
    * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+   *
+   * @deprecated Will be removed in next major version.
    */
   key?: string;
   /**
    * This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
    * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
+   *
+   * @deprecated Will be removed in next major version.
    */
   username?: string;
   /**

package/src/api/parameters/index.ts

@@ -14,6 +14,8 @@ export * from './addUserToGroupByGroupId';
 export * from './archivePages';
 export * from './asyncConvertContentBodyRequest';
 export * from './asyncConvertContentBodyResponse';
+export * from './bulkAsyncConvertContentBodyRequest';
+export * from './bulkAsyncConvertContentBodyResponse';
 export * from './checkContentPermission';
 export * from './convertContentBody';
 export * from './copyPage';
@@ -35,6 +37,7 @@ export * from './createUserProperty';
 export * from './deleteContent';
 export * from './deleteContentProperty';
 export * from './deleteContentVersion';
+export * from './deleteGroupById';
 export * from './deleteLabelFromSpace';
 export * from './deletePageTree';
 export * from './deleteRelationship';
@@ -71,6 +74,7 @@ export * from './getContentRestrictionStatusForGroup';
 export * from './getContentRestrictionStatusForUser';
 export * from './getContentState';
 export * from './getContentStateSettings';
+export * from './getContentsWithState';
 export * from './getContentTemplate';
 export * from './getContentTemplates';
 export * from './getContentVersion';

package/src/api/parameters/searchUser.ts

@@ -24,4 +24,11 @@ export interface SearchUser {
    * - `personalSpace` returns the personal space of the user.
    */
   expand?: string[];
+  /**
+   * Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator` for
+   * external/guest users, and `all` to include all permission types.
+   *
+   * @default none
+   */
+  sitePermissionTypeFilter?: 'all' | 'externalCollaborator' | 'none' | string;
 }