@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,113 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type LabelArray, type LabelCreate, type LongTask } from "../models/common";
+/** APIs in this section can change without any prior deprecation notice. */
+export declare class ExperimentalService extends CommonHttpService {
+    /**
+     * Adds labels to a piece of content. Does not modify the existing labels.
+     *
+     * Notes:
+     *
+     * - Labels can also be added when creating content ([Create
+     * content](#api-content-post)).
+     * - Labels can be updated when updating content ([Update
+     * content](#api-content-id-put)).
+     * This will delete the existing labels and replace them with the labels in
+     * the request.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the labels are added to the content.
+     * @path {POST} /wiki/rest/api/space/{spaceKey}/label
+     * @scopes-current write:confluence-space
+     * @scopes-beta read:label:confluence, write:label:confluence
+     */
+    addLabelsToSpace({ spaceKey, labelCreates, }: {
+        /** The key of the space to add labels to. */
+        spaceKey: string;
+        /** The labels to add to the content. */
+        labelCreates: LabelCreate[];
+    }): Promise<LabelArray>;
+    /**
+     * @path {DELETE} /wiki/rest/api/space/{spaceKey}/label
+     * @scopes-current write:confluence-space
+     * @scopes-beta write:label:confluence
+     */
+    deleteLabelFromSpace({ spaceKey, name, prefix, }: {
+        /** The key of the space to remove a labels from. */
+        spaceKey: string;
+        /** The name of the label to remove */
+        name: string;
+        /** The prefix of the label to remove. If not provided defaults to global. */
+        prefix?: string;
+    }): Promise<void>;
+    /**
+     * Moves a pagetree rooted at a page to the space's trash:
+     *
+     * - If the content's type is `page` and its status is `current`, it will be
+     * trashed including
+     * all its descendants.
+     * - For every other combination of content type and status, this API is not
+     * supported.
+     *
+     * This API accepts the pageTree delete request and returns a task ID.
+     * The delete process happens asynchronously.
+     *
+     *  Response example:
+     *  <pre><code>
+     *  {
+     *       "id" : "1180606",
+     *       "links" : {
+     *            "status" : "/rest/api/longtask/1180606"
+     *       }
+     *  }
+     *  </code></pre>
+     *  Use the `/longtask/<taskId>` REST API to get the copy task status.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Delete' permission for the space that the content is in.
+     *
+     * @returns Returned if the request to trash content and all its current page descendants,
+     * is successfully accepted.
+     * @path {DELETE} /wiki/rest/api/content/{id}/pageTree
+     * @scopes-current write:confluence-content
+     * @scopes-beta delete:content:confluence
+     */
+    deletePageTree({ id, }: {
+        /** The ID of the content which forms root of the page tree, to be deleted. */
+        id: string;
+    }): Promise<LongTask>;
+    /**
+     * Returns a list of labels associated with a space. Can provide a prefix as well
+     * as other filters to
+     * select different types of labels.
+     *
+     * @returns Returned if the list of labels is returned.
+     * @path {GET} /wiki/rest/api/space/{spaceKey}/label
+     * @scopes-current read:confluence-space.summary
+     * @scopes-beta read:label:confluence
+     */
+    getLabelsForSpace({ spaceKey, prefix, start, limit, }: {
+        /** The key of the space to get labels for. */
+        spaceKey: string;
+        /**
+         * Filters the results to labels with the specified prefix. If this parameter
+         * is not specified, then labels with any prefix will be returned.
+         *
+         * - `global` prefix is used by labels that are on content within the provided
+         * space.
+         * - `my` prefix can be explicitly added by a user when adding a label
+         * via the UI, e.g. 'my:example-label'.
+         * - `team` prefix is used for labels applied to the space.
+         */
+        prefix?: "global" | "my" | "team";
+        /** The starting index of the returned labels. */
+        start?: number;
+        /**
+         * The maximum number of labels to return per page. Note,
+         * this may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<LabelArray>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExperimentalService = 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 validationSchemaStorage_1 = require("../validationSchemaStorage");
+/** APIs in this section can change without any prior deprecation notice. */
+class ExperimentalService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Adds labels to a piece of content. Does not modify the existing labels.
+     *
+     * Notes:
+     *
+     * - Labels can also be added when creating content ([Create
+     * content](#api-content-post)).
+     * - Labels can be updated when updating content ([Update
+     * content](#api-content-id-put)).
+     * This will delete the existing labels and replace them with the labels in
+     * the request.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the content.
+     *
+     * @returns Returned if the labels are added to the content.
+     * @path {POST} /wiki/rest/api/space/{spaceKey}/label
+     * @scopes-current write:confluence-space
+     * @scopes-beta read:label:confluence, write:label:confluence
+     */
+    addLabelsToSpace({ spaceKey, labelCreates, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/label",
+            method: "POST",
+            pathParams: {
+                spaceKey,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: labelCreates,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ExperimentalService.addLabelsToSpace.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * @path {DELETE} /wiki/rest/api/space/{spaceKey}/label
+     * @scopes-current write:confluence-space
+     * @scopes-beta write:label:confluence
+     */
+    deleteLabelFromSpace({ spaceKey, name, prefix, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/label",
+            method: "DELETE",
+            pathParams: {
+                spaceKey,
+            },
+            query: {
+                name,
+                prefix,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Moves a pagetree rooted at a page to the space's trash:
+     *
+     * - If the content's type is `page` and its status is `current`, it will be
+     * trashed including
+     * all its descendants.
+     * - For every other combination of content type and status, this API is not
+     * supported.
+     *
+     * This API accepts the pageTree delete request and returns a task ID.
+     * The delete process happens asynchronously.
+     *
+     *  Response example:
+     *  <pre><code>
+     *  {
+     *       "id" : "1180606",
+     *       "links" : {
+     *            "status" : "/rest/api/longtask/1180606"
+     *       }
+     *  }
+     *  </code></pre>
+     *  Use the `/longtask/<taskId>` REST API to get the copy task status.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Delete' permission for the space that the content is in.
+     *
+     * @returns Returned if the request to trash content and all its current page descendants,
+     * is successfully accepted.
+     * @path {DELETE} /wiki/rest/api/content/{id}/pageTree
+     * @scopes-current write:confluence-content
+     * @scopes-beta delete:content:confluence
+     */
+    deletePageTree({ id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/content/{id}/pageTree",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            202: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ExperimentalService.deletePageTree.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a list of labels associated with a space. Can provide a prefix as well
+     * as other filters to
+     * select different types of labels.
+     *
+     * @returns Returned if the list of labels is returned.
+     * @path {GET} /wiki/rest/api/space/{spaceKey}/label
+     * @scopes-current read:confluence-space.summary
+     * @scopes-beta read:label:confluence
+     */
+    getLabelsForSpace({ spaceKey, prefix, start, limit, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/space/{spaceKey}/label",
+            method: "GET",
+            pathParams: {
+                spaceKey,
+            },
+            query: {
+                prefix,
+                start,
+                limit,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ExperimentalService.getLabelsForSpace.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ExperimentalService.deletePageTree.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(202),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("LongTask"),
+        })
+            .describe("ExperimentalService.deletePageTree.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ExperimentalService.getLabelsForSpace.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("LabelArray"),
+        })
+            .describe("ExperimentalService.getLabelsForSpace.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ExperimentalService.addLabelsToSpace.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("LabelArray"),
+        })
+            .describe("ExperimentalService.addLabelsToSpace.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.ExperimentalService = ExperimentalService;
+//# sourceMappingURL=ExperimentalService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExperimentalService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ExperimentalService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAK0B;AAC1B,wEAAqE;AACrE,4EAA4E;AAC5E,MAAa,mBAAoB,SAAQ,qCAAiB;IACxD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gBAAgB,CAAC,EACf,QAAQ,EACR,YAAY,GAMb;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uCAAuC;YAC7C,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,YAAY;SACnB,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,+CAA+C,CAChD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;OAIG;IACH,oBAAoB,CAAC,EACnB,QAAQ,EACR,IAAI,EACJ,MAAM,GAQP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uCAAuC;YAC7C,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;aACP;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,cAAc,CAAC,EACb,EAAE,GAIH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sCAAsC;YAC5C,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;aACH;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,6CAA6C,CAC9C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAChB,QAAQ,EACR,MAAM,EACN,KAAK,EACL,KAAK,GAsBN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uCAAuC;YAC7C,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,QAAQ;aACT;YACD,KAAK,EAAE;gBACL,MAAM;gBACN,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,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,6CAA6C,EAC7C,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,UAAU,CAAC;SAC/C,CAAC;aACD,QAAQ,CAAC,6CAA6C,CAAC,CAC3D,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,YAAY,CAAC;SACjD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,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,+CAA+C,CAAC,CAC7D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAzQD,kDAyQC"}

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

@@ -0,0 +1,379 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type Group, type GroupArrayWithLinks, type UserArray } from "../models/common";
+import type { AccountId, GroupName } from "../models/group";
+/**
+ * **[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/)
+ * The standard Atlassian group names are default names only and can be edited or
+ * deleted.**  For example, an admin or Atlassian support could delete the default
+ * group jira-software-users or rename it to jsw-users at any point.
+ */
+export declare class GroupService extends CommonHttpService {
+    /**
+     * Adds a user as a member in a group.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * User must be a site admin.
+     *
+     * @deprecated
+     * @path {POST} /wiki/rest/api/group/user
+     * @scopes-current write:confluence-groups
+     * @scopes-beta write:group:confluence
+     */
+    addUserToGroup({ name, accountId, }: {
+        /** Name of the group whose membership is updated */
+        name: string;
+        /** AccountId of the user who needs to be added as member. */
+        accountId: AccountId;
+    }): Promise<void>;
+    /**
+     * Adds a user as a member in a group represented by its groupId
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * User must be a site admin.
+     *
+     * @path {POST} /wiki/rest/api/group/userByGroupId
+     * @scopes-current write:confluence-groups
+     * @scopes-beta write:group:confluence
+     */
+    addUserToGroupByGroupId({ groupId, accountId, }: {
+        /** GroupId of the group whose membership is updated */
+        groupId: string;
+        /** AccountId of the user who needs to be added as member. */
+        accountId: AccountId;
+    }): Promise<void>;
+    /**
+     * Creates a new user group.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * User must be a site admin.
+     *
+     * @returns Returned if the group was created successfully.
+     * @path {POST} /wiki/rest/api/group
+     * @scopes-current write:confluence-groups
+     * @scopes-beta read:group:confluence, write:group:confluence
+     */
+    createGroup({ groupName, }: {
+        /** Name of the group that is to be created. */
+        groupName: GroupName;
+    }): Promise<Group>;
+    /**
+     * Returns a user group for a given group id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested group is returned.
+     * @path {GET} /wiki/rest/api/group/by-id
+     * @scopes-current read:confluence-groups
+     * @scopes-beta read:group:confluence
+     */
+    getGroupByGroupId({ id, }: {
+        /** The id of the group. */
+        id: string;
+    }): Promise<Group>;
+    /**
+     * Returns a user group for a given group name.
+     *
+     * Use updated Get group API
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @deprecated
+     * @returns Returned if the requested group is returned.
+     * @path {GET} /wiki/rest/api/group/{groupName}
+     */
+    getGroupByName({ groupName, }: {
+        /**
+         * The name of the group. This is the same as the group name shown in
+         * the Confluence administration console.
+         */
+        groupName: string;
+    }): Promise<Group>;
+    /**
+     * Returns a user group for a given group name.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @deprecated
+     * @returns Returned if the requested group is returned.
+     * @path {GET} /wiki/rest/api/group/by-name
+     * @scopes-current read:confluence-groups
+     * @scopes-beta read:group:confluence
+     */
+    getGroupByQueryParam({ name, }: {
+        /**
+         * The name of the group. This is the same as the group name shown in
+         * the Confluence administration console.
+         */
+        name: string;
+    }): Promise<Group>;
+    /**
+     * 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
+     * @returns Returned if the requested users are returned.
+     * @path {GET} /wiki/rest/api/group/{groupName}/member
+     */
+    getGroupMembers({ groupName, start, limit, }: {
+        /** The name of the group to be queried for its members. */
+        groupName: string;
+        /** The starting index of the returned users. */
+        start?: number;
+        /**
+         * The maximum number of users to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<UserArray>;
+    /**
+     * 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).
+     *
+     * @returns Returned if the requested users are returned.
+     * @path {GET} /wiki/rest/api/group/{groupId}/membersByGroupId
+     * @scopes-current read:confluence-groups
+     * @scopes-beta read:group:confluence, read:user:confluence
+     */
+    getGroupMembersByGroupId({ groupId, start, limit, shouldReturnTotalSize, expand, }: {
+        /** The id of the group to be queried for its members. */
+        groupId: string;
+        /** The starting index of the returned users. */
+        start?: number;
+        /**
+         * The maximum number of users to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+        /**
+         * Whether to include total size parameter in the results.
+         * Note, fetching total size property is an expensive 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.
+         *   - `isExternalCollaborator` returns whether the user is an external
+         * collaborator user.
+         */
+        expand?: ("operations" | "personalSpace" | "isExternalCollaborator")[];
+    }): Promise<UserArray>;
+    /**
+     * Returns all user groups. The returned groups are ordered alphabetically in
+     * ascending order by group name.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested groups are returned.
+     * @path {GET} /wiki/rest/api/group
+     * @scopes-current read:confluence-groups
+     * @scopes-beta read:group:confluence
+     */
+    getGroups({ start, limit, accessType, }: {
+        /** The starting index of the returned groups. */
+        start?: number;
+        /**
+         * The maximum number of groups to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+        /** The group permission level for which to filter results. */
+        accessType?: "user" | "admin" | "site-admin";
+    }): Promise<GroupArrayWithLinks>;
+    /**
+     * Returns the users that are members of a group.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @deprecated
+     * @returns Returned if the requested users are returned.
+     * @path {GET} /wiki/rest/api/group/member
+     * @scopes-current read:confluence-groups
+     * @scopes-beta read:group:confluence, read:user:confluence
+     */
+    getMembersByQueryParam({ name, start, limit, shouldReturnTotalSize, expand, }: {
+        /** The name of the group to be queried for its members. */
+        name: string;
+        /** The starting index of the returned users. */
+        start?: number;
+        /**
+         * The maximum number of users to return per page.
+         * Note, this is restricted by fixed system limit of 200 which is to say if the
+         * limit parameter
+         * exceeds 200, this API will return a maximum of 200 users per page.
+         */
+        limit?: number;
+        /**
+         * Whether to include total size parameter in the results.
+         * Note, fetching total size property is an expensive 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.
+         *   - `isExternalCollaborator` returns whether the user is an external
+         * collaborator user.
+         */
+        expand?: ("operations" | "personalSpace" | "isExternalCollaborator")[];
+    }): Promise<UserArray>;
+    /**
+     * Delete user group.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * User must be a site admin.
+     *
+     * @deprecated
+     * @path {DELETE} /wiki/rest/api/group
+     * @scopes-current write:confluence-groups
+     * @scopes-beta write:group:confluence
+     */
+    removeGroup({ name, }: {
+        /** Name of the group to delete. */
+        name: string;
+    }): Promise<void>;
+    /**
+     * Delete user group.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * User must be a site admin.
+     *
+     * @path {DELETE} /wiki/rest/api/group/by-id
+     * @scopes-current write:confluence-groups
+     * @scopes-beta write:group:confluence
+     */
+    removeGroupById({ id, }: {
+        /** Id of the group to delete. */
+        id: string;
+    }): Promise<void>;
+    /**
+     * Remove user as a member from a group.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * User must be a site admin.
+     *
+     * @deprecated
+     * @path {DELETE} /wiki/rest/api/group/user
+     * @scopes-current write:confluence-groups
+     * @scopes-beta write:group:confluence
+     */
+    removeMemberFromGroup({ name, key, username, accountId, }: {
+        /** Name of the group whose membership is updated. */
+        name: 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
+         */
+        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
+         */
+        username?: string;
+        /**
+         * The account ID of the user. The accountId uniquely identifies the user across
+         * all Atlassian products.
+         * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
+         */
+        accountId?: string;
+    }): Promise<void>;
+    /**
+     * Remove user as a member from a group.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * User must be a site admin.
+     *
+     * @path {DELETE} /wiki/rest/api/group/userByGroupId
+     * @scopes-current write:confluence-groups
+     * @scopes-beta write:group:confluence
+     */
+    removeMemberFromGroupByGroupId({ groupId, key, username, accountId, }: {
+        /** Id of the group whose membership is updated. */
+        groupId: 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
+         */
+        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
+         */
+        username?: string;
+        /**
+         * The account ID of the user. The accountId uniquely identifies the user across
+         * all Atlassian products.
+         * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
+         */
+        accountId?: string;
+    }): Promise<void>;
+    /**
+     * Get search results of groups by partial query provided.
+     *
+     * @returns Returns a full JSON representation of group collection.
+     * @path {GET} /wiki/rest/api/group/picker
+     * @scopes-current read:confluence-groups
+     * @scopes-beta read:group:confluence
+     */
+    searchGroups({ query, start, limit, shouldReturnTotalSize, }: {
+        /** the search term used to query results. */
+        query: string;
+        /** The starting index of the returned groups. */
+        start?: number;
+        /**
+         * The maximum number of groups to return per page.
+         * Note, this is restricted to a maximum limit of 200 groups.
+         */
+        limit?: number;
+        /**
+         * Whether to include total size parameter in the results.
+         * Note, fetching total size property is an expensive operation; use it if your
+         * use case needs this value.
+         */
+        shouldReturnTotalSize?: boolean;
+    }): Promise<GroupArrayWithLinks>;
+    static initialize(): void;
+}