confluence.js 2.0.0 → 2.2.0-dev20260318121920

package/dist/esm/types/api/group.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class Group {
     private client;
     constructor(client: Client);
@@ -35,12 +35,16 @@ export declare 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.
      */
     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.
      */
     removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback?: never): Promise<T>;
     /**
@@ -48,6 +52,8 @@ export declare 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.
      */
     getGroupByQueryParam<T = Models.Group>(parameters: Parameters.GetGroupByQueryParam, callback: Callback<T>): Promise<void>;
     /**
@@ -55,6 +61,8 @@ export declare 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.
      */
     getGroupByQueryParam<T = Models.Group>(parameters: Parameters.GetGroupByQueryParam, callback?: never): Promise<T>;
     /**
@@ -76,13 +84,13 @@ export declare class Group {
      *
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
      */
-    removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback: Callback<T>): Promise<void>;
+    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.
      */
-    removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback?: never): Promise<T>;
+    removeGroupById<T = void>(parameters: Parameters.DeleteGroupById, callback?: never): Promise<T>;
     /**
      * Returns a user group for a given group name.
      *
@@ -90,6 +98,8 @@ export declare 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.
      */
     getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback: Callback<T>): Promise<void>;
     /**
@@ -99,6 +109,8 @@ export declare 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.
      */
     getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback?: never): Promise<T>;
     /**
@@ -106,6 +118,8 @@ export declare 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.
      */
     getMembersByQueryParam<T = Models.UserArray>(parameters: Parameters.GetMembersByQueryParam, callback: Callback<T>): Promise<void>;
     /**
@@ -113,8 +127,14 @@ export declare 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.
      */
     getMembersByQueryParam<T = Models.UserArray>(parameters: Parameters.GetMembersByQueryParam, callback?: never): Promise<T>;
+    /** Get search results of groups by partial query provided. */
+    searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback: Callback<T>): Promise<void>;
+    /** Get search results of groups by partial query provided. */
+    searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;
     /**
      * Returns the users that are members of a group.
      *
@@ -123,7 +143,7 @@ export declare class Group {
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
      */
-    getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback: Callback<T>): Promise<void>;
+    getGroupMembersByGroupId<T = Models.UserArray>(parameters: Parameters.GetGroupMembersByGroupId, callback: Callback<T>): Promise<void>;
     /**
      * Returns the users that are members of a group.
      *
@@ -132,11 +152,7 @@ export declare class Group {
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
      * ('Can use' global permission).
      */
-    getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback?: never): Promise<T>;
-    /** Get search results of groups by partial query provided. */
-    searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback: Callback<T>): Promise<void>;
-    /** Get search results of groups by partial query provided. */
-    searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;
+    getGroupMembersByGroupId<T = Models.UserArray>(parameters: Parameters.GetGroupMembersByGroupId, callback?: never): Promise<T>;
     /**
      * Adds a user as a member in a group represented by its groupId
      *
@@ -161,24 +177,6 @@ export declare class Group {
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
      */
     removeMemberFromGroupByGroupId<T = void>(parameters: Parameters.RemoveMemberFromGroupByGroupId, callback?: never): Promise<T>;
-    /**
-     * 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).
-     */
-    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).
-     */
-    getGroupMembersByGroupId<T = Models.UserArray>(parameters: Parameters.GetGroupMembersByGroupId, callback?: never): Promise<T>;
     /**
      * Adds a user as a member in a group.
      *
@@ -203,4 +201,26 @@ export declare class Group {
      * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
      */
     removeMemberFromGroup<T = void>(parameters: Parameters.RemoveMemberFromGroup, callback?: never): Promise<T>;
+    /**
+     * 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`
+     */
+    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`
+     */
+    getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback?: never): Promise<T>;
 }

package/dist/esm/types/api/index.d.ts

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

package/dist/esm/types/api/inlineTasks.d.ts

@@ -2,6 +2,7 @@ import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
 import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+/** @deprecated Will be removed in next major version. */
 export declare class InlineTasks {
     private client;
     constructor(client: Client);
@@ -10,6 +11,8 @@ export declare 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.
      */
     searchTasks<T = Models.TaskPageResponse>(parameters: Parameters.SearchTasks | undefined, callback: Callback<T>): Promise<void>;
     /**
@@ -17,6 +20,8 @@ export declare 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.
      */
     searchTasks<T = Models.TaskPageResponse>(parameters?: Parameters.SearchTasks, callback?: never): Promise<T>;
     /**
@@ -24,6 +29,8 @@ export declare 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.
      */
     getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback: Callback<T>): Promise<void>;
     /**
@@ -31,6 +38,8 @@ export declare 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.
      */
     getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: never): Promise<T>;
     /**
@@ -38,6 +47,8 @@ export declare 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.
      */
     updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback: Callback<T>): Promise<void>;
     /**
@@ -45,6 +56,8 @@ export declare 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.
      */
     updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback?: never): Promise<T>;
 }

package/dist/esm/types/api/labelInfo.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class LabelInfo {
     private client;
     constructor(client: Client);

package/dist/esm/types/api/longRunningTask.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class LongRunningTask {
     private client;
     constructor(client: Client);

package/dist/esm/types/api/models/spaceCreate.d.ts

@@ -2,10 +2,19 @@ import type { SpaceDescriptionCreate } from "./spaceDescriptionCreate.js";
 import type { SpacePermission } from "./spacePermission.js";
 /** 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/dist/esm/types/api/models/spacePrivateCreate.d.ts

@@ -2,10 +2,19 @@ import type { SpaceDescriptionCreate } from "./spaceDescriptionCreate.js";
 import type { SpacePermissionCreate } from "./spacePermissionCreate.js";
 /** 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/dist/esm/types/api/parameters/bulkAsyncConvertContentBodyRequest.d.ts

@@ -0,0 +1,58 @@
+import type { OneOrMany } from "../../interfaces/index.js";
+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. */
+    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/dist/esm/types/api/parameters/bulkAsyncConvertContentBodyResponse.d.ts

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

package/dist/esm/types/api/parameters/deleteGroupById.d.ts

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

package/dist/esm/types/api/parameters/downloadAttachment.d.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/dist/esm/types/api/parameters/getContentChildren.d.ts

@@ -1,3 +1,4 @@
+import type { OneOrMany } from "../../interfaces/index.js";
 export interface GetContentChildren {
     /** The ID of the content to be queried for its children. */
     id: string;
@@ -9,7 +10,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/dist/esm/types/api/parameters/getContentsWithState.d.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/dist/esm/types/api/parameters/getGroupMembersByGroupId.d.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/dist/esm/types/api/parameters/getGroupMembershipsForUser.d.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/dist/esm/types/api/parameters/getTasks.d.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/dist/esm/types/api/parameters/getUser.d.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/dist/esm/types/api/parameters/index.d.ts

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

package/dist/esm/types/api/parameters/searchUser.d.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;
 }

package/dist/esm/types/api/relation.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class Relation {
     private client;
     constructor(client: Client);
@@ -10,8 +10,8 @@ export declare 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.
@@ -22,8 +22,8 @@ export declare 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.
@@ -35,7 +35,7 @@ export declare 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.
@@ -47,7 +47,7 @@ export declare 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.
@@ -58,7 +58,7 @@ export declare 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).
@@ -69,7 +69,7 @@ export declare 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).
@@ -96,9 +96,8 @@ export declare 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.
@@ -109,9 +108,8 @@ export declare 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/dist/esm/types/api/search.d.ts

@@ -1,7 +1,7 @@
 import type * as Models from "./models/index.js";
 import type * as Parameters from "./parameters/index.js";
-import type { Callback } from "../callback.js";
 import type { Client } from "../clients/index.js";
+import type { Callback } from "../callback.js";
 export declare class Search {
     private client;
     constructor(client: Client);
@@ -33,6 +33,9 @@ export declare 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.
      */
@@ -41,6 +44,9 @@ export declare 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.
      */