@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,503 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type ContentRestriction } from "../models/common";
+import { type ContentRestrictionAddOrUpdateArray, type ContentRestrictionArray } from "../models/contentRestrictions";
+export declare class ContentRestrictionsService extends CommonHttpService {
+    /**
+     * Deprecated, use [Add group to content restriction via
+     * groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-put).
+     * Adds a group to a content restriction. That is, grant read or update
+     * permission to the group for a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the content.
+     *
+     * @deprecated
+     * @path {PUT}
+     * /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:content.restriction:confluence
+     */
+    addGroupToContentRestriction({ id, operationKey, groupName, }: {
+        /** The ID of the content that the restriction applies to. */
+        id: string;
+        /** The operation that the restriction applies to. */
+        operationKey: "read" | "update";
+        /** The name of the group to add to the content restriction. */
+        groupName: string;
+    }): Promise<void>;
+    /**
+     * Adds a group to a content restriction by Group Id. That is, grant read or update
+     * permission to the group for a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the content.
+     *
+     * @path {PUT}
+     * /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:content.restriction:confluence
+     */
+    addGroupToContentRestrictionByGroupId({ id, operationKey, groupId, }: {
+        /** The ID of the content that the restriction applies to. */
+        id: string;
+        /** The operation that the restriction applies to. */
+        operationKey: "read" | "update";
+        /** The groupId of the group to add to the content restriction. */
+        groupId: string;
+    }): Promise<void>;
+    /**
+     * Adds restrictions to a piece of content. Note, this does not change any
+     * existing restrictions on the content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the content.
+     *
+     * @returns Returned if the requested restrictions are added.
+     * @path {POST} /wiki/rest/api/content/{id}/restriction
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:content.restriction:confluence
+     */
+    addRestrictions({ id, expand, contentRestrictionAddOrUpdateArray, }: {
+        /** The ID of the content to add restrictions to. */
+        id: string;
+        /**
+         * A multi-value parameter indicating which properties of the content
+         * restrictions (returned in response) to expand.
+         *
+         * - `restrictions.user` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `restrictions.group` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `content` returns the piece of content that the restrictions are
+         * applied to.
+         */
+        expand?: ("restrictions.user" | "read.restrictions.user" | "update.restrictions.user" | "restrictions.group" | "read.restrictions.group" | "update.restrictions.group" | "content")[];
+        /** The restrictions to be added to the content. */
+        contentRestrictionAddOrUpdateArray: ContentRestrictionAddOrUpdateArray;
+    }): Promise<ContentRestrictionArray>;
+    /**
+     * Adds a user to a content restriction. That is, grant read or update
+     * permission to the user for a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the content.
+     *
+     * @path {PUT} /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:content.restriction:confluence
+     */
+    addUserToContentRestriction({ id, operationKey, key, username, accountId, }: {
+        /** The ID of the content that the restriction applies to. */
+        id: string;
+        /** The operation that the restriction applies to. */
+        operationKey: 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>;
+    /**
+     * Removes all restrictions (read and update) on a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the content.
+     *
+     * @returns Returned if the restrictions are removed.
+     * @path {DELETE} /wiki/rest/api/content/{id}/restriction
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:content.restriction:confluence
+     */
+    deleteRestrictions({ id, expand, }: {
+        /** The ID of the content to remove restrictions from. */
+        id: string;
+        /**
+         * A multi-value parameter indicating which properties of the content
+         * restrictions (returned in response) to expand.
+         *
+         * - `restrictions.user` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `restrictions.group` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `content` returns the piece of content that the restrictions are
+         * applied to.
+         */
+        expand?: ("restrictions.user" | "read.restrictions.user" | "update.restrictions.user" | "restrictions.group" | "read.restrictions.group" | "update.restrictions.group" | "content")[];
+    }): Promise<ContentRestrictionArray>;
+    /**
+     * Deprecated, use [Get content restriction status for group via
+     * groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-get).
+     * Returns whether the specified content restriction applies to a group.
+     * For example, if a page with `id=123` has a `read` restriction for the `admins`
+     * group,
+     * the following request will return `true`:
+     *
+     * `/wiki/rest/api/content/123/restriction/byOperation/read/group/admins`
+     *
+     * Note that a response of `true` does not guarantee that the group can view the
+     * page, as it does not account for
+     * account-inherited restrictions, space permissions, or even product access. For
+     * more
+     * information, see [Confluence
+     * permissions](https://confluence.atlassian.com/x/_AozKw).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content.
+     *
+     * @deprecated
+     * @path {GET}
+     * /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.restriction:confluence
+     */
+    getContentRestrictionStatusForGroup({ id, operationKey, groupName, }: {
+        /** The ID of the content that the restriction applies to. */
+        id: string;
+        /** The operation that the restriction applies to. */
+        operationKey: "read" | "update";
+        /**
+         * The name of the group to be queried for whether the content restriction
+         * applies to it.
+         */
+        groupName: string;
+    }): Promise<void>;
+    /**
+     * Returns whether the specified content restriction applies to a user.
+     * For example, if a page with `id=123` has a `read` restriction for a user with
+     * an account ID of
+     * `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`, the following request will
+     * return `true`:
+     *
+     * `/wiki/rest/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`
+     *
+     * Note that a response of `true` does not guarantee that the user can view the
+     * page, as it does not account for
+     * account-inherited restrictions, space permissions, or even product access. For
+     * more
+     * information, see [Confluence
+     * permissions](https://confluence.atlassian.com/x/_AozKw).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content.
+     *
+     * @path {GET} /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.restriction:confluence
+     */
+    getContentRestrictionStatusForUser({ id, operationKey, key, username, accountId, }: {
+        /** The ID of the content that the restriction applies to. */
+        id: string;
+        /** The operation that is restricted. */
+        operationKey: 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>;
+    /**
+     * Returns whether the specified content restriction applies to a group.
+     * For example, if a page with `id=123` has a `read` restriction for the `123456`
+     * group id,
+     * the following request will return `true`:
+     *
+     * `/wiki/rest/api/content/123/restriction/byOperation/read/byGroupId/123456`
+     *
+     * Note that a response of `true` does not guarantee that the group can view the
+     * page, as it does not account for
+     * account-inherited restrictions, space permissions, or even product access. For
+     * more
+     * information, see [Confluence
+     * permissions](https://confluence.atlassian.com/x/_AozKw).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content.
+     *
+     * @path {GET}
+     * /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content.restriction:confluence
+     */
+    getIndividualGroupRestrictionStatusByGroupId({ id, operationKey, groupId, }: {
+        /** The ID of the content that the restriction applies to. */
+        id: string;
+        /** The operation that the restriction applies to. */
+        operationKey: "read" | "update";
+        /**
+         * The id of the group to be queried for whether the content restriction
+         * applies to it.
+         */
+        groupId: string;
+    }): Promise<void>;
+    /**
+     * Returns the restrictions on a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content.
+     *
+     * @returns Returned if the requested restrictions are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/restriction
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content-details:confluence
+     */
+    getRestrictions({ id, expand, start, limit, }: {
+        /** The ID of the content to be queried for its restrictions. */
+        id: string;
+        /**
+         * A multi-value parameter indicating which properties of the content
+         * restrictions to expand. By default, the following objects are expanded:
+         * `restrictions.user`, `restrictions.group`.
+         *
+         * - `restrictions.user` returns the piece of content that the restrictions are
+         * applied to.
+         * - `restrictions.group` returns the piece of content that the restrictions are
+         * applied to.
+         * - `content` returns the piece of content that the restrictions are
+         * applied to.
+         */
+        expand?: ("restrictions.user" | "read.restrictions.user" | "update.restrictions.user" | "restrictions.group" | "read.restrictions.group" | "update.restrictions.group" | "content")[];
+        /** The starting index of the users and groups in the returned restrictions. */
+        start?: number;
+        /**
+         * The maximum number of users and the maximum number of groups, in the
+         * returned restrictions, to return per page. Note, this may be restricted
+         * by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<ContentRestrictionArray>;
+    /**
+     * Returns restrictions on a piece of content by operation. This method is
+     * similar to [Get restrictions](#api-content-id-restriction-get) except that
+     * the operations are properties of the return object, rather than items in
+     * a results array.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content.
+     *
+     * @returns Returned if the requested restrictions are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/restriction/byOperation
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content-details:confluence
+     */
+    getRestrictionsByOperation({ id, expand, }: {
+        /** The ID of the content to be queried for its restrictions. */
+        id: string;
+        /**
+         * A multi-value parameter indicating which properties of the content
+         * restrictions to expand.
+         *
+         * - `restrictions.user` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `restrictions.group` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `content` returns the piece of content that the restrictions are
+         * applied to.
+         */
+        expand?: ("restrictions.user" | "restrictions.group" | "content")[];
+    }): Promise<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Returns the restictions on a piece of content for a given operation (read
+     * or update).
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content.
+     *
+     * @returns Returned if the requested restrictions are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}
+     * @scopes-current read:confluence-content.all
+     * @scopes-beta read:content-details:confluence
+     */
+    getRestrictionsForOperation({ id, operationKey, expand, start, limit, }: {
+        /** The ID of the content to be queried for its restrictions. */
+        id: string;
+        /** The operation type of the restrictions to be returned. */
+        operationKey: "read" | "update";
+        /**
+         * A multi-value parameter indicating which properties of the content
+         * restrictions to expand.
+         *
+         * - `restrictions.user` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `restrictions.group` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `content` returns the piece of content that the restrictions are
+         * applied to.
+         */
+        expand?: ("restrictions.user" | "restrictions.group" | "content")[];
+        /** The starting index of the users and groups in the returned restrictions. */
+        start?: number;
+        /**
+         * The maximum number of users and the maximum number of groups, in the
+         * returned restrictions, to return per page. Note, this may be restricted
+         * by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<ContentRestriction>;
+    /**
+     * Removes a group from a content restriction. That is, remove read or update
+     * permission for the group for a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the content.
+     *
+     * @path {DELETE}
+     * /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:content.restriction:confluence
+     */
+    removeGroupFromContentRestriction({ id, operationKey, groupId, }: {
+        /** The ID of the content that the restriction applies to. */
+        id: string;
+        /** The operation that the restriction applies to. */
+        operationKey: "read" | "update";
+        /** The id of the group to remove from the content restriction. */
+        groupId: string;
+    }): Promise<void>;
+    /**
+     * Deprecated, use [Remove group from content restriction by
+     * groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-user-delete).
+     * Removes a group from a content restriction. That is, remove read or update
+     * permission for the group for a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the content.
+     *
+     * @deprecated
+     * @path {DELETE}
+     * /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:content.restriction:confluence
+     */
+    removeGroupFromContentRestrictionById({ id, operationKey, groupName, }: {
+        /** The ID of the content that the restriction applies to. */
+        id: string;
+        /** The operation that the restriction applies to. */
+        operationKey: "read" | "update";
+        /** The name of the group to remove from the content restriction. */
+        groupName: string;
+    }): Promise<void>;
+    /**
+     * Removes a group from a content restriction. That is, remove read or update
+     * permission for the group for a piece of content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the content.
+     *
+     * @path {DELETE} /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:content.restriction:confluence
+     */
+    removeUserFromContentRestriction({ id, operationKey, key, username, accountId, }: {
+        /** The ID of the content that the restriction applies to. */
+        id: string;
+        /** The operation that the restriction applies to. */
+        operationKey: "read" | "update";
+        /**
+         * 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>;
+    /**
+     * Updates restrictions for a piece of content. This removes the existing
+     * restrictions and replaces them with the restrictions in the request.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the content.
+     *
+     * @returns Returned if the requested restrictions are updated.
+     * @path {PUT} /wiki/rest/api/content/{id}/restriction
+     * @scopes-current write:confluence-content
+     * @scopes-beta read:content-details:confluence, write:content.restriction:confluence
+     */
+    updateRestrictions({ id, expand, contentRestrictionAddOrUpdateArray, }: {
+        /** The ID of the content to update restrictions for. */
+        id: string;
+        /**
+         * A multi-value parameter indicating which properties of the content
+         * restrictions (returned in response) to expand.
+         *
+         * - `restrictions.user` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `restrictions.group` returns the piece of content that the restrictions are
+         * applied to. Expanded by default.
+         * - `content` returns the piece of content that the restrictions are
+         * applied to.
+         */
+        expand?: ("restrictions.user" | "read.restrictions.user" | "update.restrictions.user" | "restrictions.group" | "read.restrictions.group" | "update.restrictions.group" | "content")[];
+        /** The updated restrictions for the content. */
+        contentRestrictionAddOrUpdateArray: ContentRestrictionAddOrUpdateArray;
+    }): Promise<ContentRestrictionArray>;
+    static initialize(): void;
+}