@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,550 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type SpaceWatchArray, type UserWatch, type WatchArray } from "../models/contentWatches";
+export declare class ContentWatchesService extends CommonHttpService {
+    /**
+     * Adds a user as a watcher to a piece of content. Choose the user by doing
+     * one of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * Note, you must add the `X-Atlassian-Token: no-check` header when making a
+     * request, as this operation has XSRF protection.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {POST} /wiki/rest/api/user/watch/content/{contentId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    addContentWatcher({ contentId, key, username, accountId, }: {
+        /** The ID of the content to add the watcher to. */
+        contentId: 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>;
+    /**
+     * Adds a user as a watcher to a label. Choose the user by doing one of the
+     * following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * Note, you must add the `X-Atlassian-Token: no-check` header when making a
+     * request, as this operation has XSRF protection.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {POST} /wiki/rest/api/user/watch/label/{labelName}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    addLabelWatcher({ labelName, key, username, accountId, xAtlassianToken, }: {
+        /** The name of the label to add the watcher to. */
+        labelName: 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;
+        /**
+         * Note, you must add header when making a
+         * request, as this operation has XSRF protection.
+         */
+        xAtlassianToken: string;
+    }): Promise<void>;
+    /**
+     * Adds a user as a watcher to a space. Choose the user by doing one of the
+     * following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * Note, you must add the `X-Atlassian-Token: no-check` header when making a
+     * request, as this operation has XSRF protection.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {POST} /wiki/rest/api/user/watch/space/{spaceKey}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    addSpaceWatcher({ spaceKey, key, username, accountId, xAtlassianToken, }: {
+        /** The key of the space to add the watcher to. */
+        spaceKey: 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;
+        /**
+         * Note, you must add header when making a
+         * request, as this operation has XSRF protection.
+         */
+        xAtlassianToken: string;
+    }): Promise<void>;
+    /**
+     * Returns whether a user is watching a piece of content. Choose the user by
+     * doing one of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watch status is returned.
+     * @path {GET} /wiki/rest/api/user/watch/content/{contentId}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence
+     */
+    getContentWatchStatus({ contentId, key, username, accountId, }: {
+        /**
+         * The ID of the content to be queried for whether the specified user is
+         * watching it.
+         */
+        contentId: 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<UserWatch>;
+    /**
+     * Returns a list of watchers of a space
+     *
+     * @returns Returned if watchers list is returned.
+     * @path {GET} /wiki/rest/api/space/{spaceKey}/watch
+     * @scopes-current read:watcher:confluence, read:user:confluence
+     */
+    getWatchersForSpace({ spaceKey, start, limit, }: {
+        /** The key of the space to get watchers. */
+        spaceKey: string;
+        /** The start point of the collection to return. */
+        start?: string;
+        /**
+         * The limit of the number of items to return, this may be restricted by fixed
+         * system limits.
+         */
+        limit?: string;
+    }): Promise<SpaceWatchArray>;
+    /**
+     * Returns the watches for a page. A user that watches a page will receive
+     * receive notifications when the page is updated.
+     *
+     * If you want to manage watches for a page, use the following `user` methods:
+     *
+     * - [Get content watch status for user](#api-user-watch-content-contentId-get)
+     * - [Add content watch](#api-user-watch-content-contentId-post)
+     * - [Remove content watch](#api-user-watch-content-contentId-delete)
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watches are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/notification/child-created
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence, read:user:confluence
+     */
+    getWatchesForPage({ id, start, limit, }: {
+        /** The ID of the content to be queried for its watches. */
+        id: string;
+        /** The starting index of the returned watches. */
+        start?: number;
+        /**
+         * The maximum number of watches to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<WatchArray>;
+    /**
+     * Returns all space watches for the space that the content is in. A user that
+     * watches a space will receive receive notifications when any content in the
+     * space is updated.
+     *
+     * If you want to manage watches for a space, use the following `user` methods:
+     *
+     * - [Get space watch status for user](#api-user-watch-space-spaceKey-get)
+     * - [Add space watch](#api-user-watch-space-spaceKey-post)
+     * - [Remove space watch](#api-user-watch-space-spaceKey-delete)
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watches are returned.
+     * @path {GET} /wiki/rest/api/content/{id}/notification/created
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence, read:user:confluence
+     */
+    getWatchesForSpace({ id, start, limit, }: {
+        /** The ID of the content to be queried for its watches. */
+        id: string;
+        /** The starting index of the returned watches. */
+        start?: number;
+        /**
+         * The maximum number of watches to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<SpaceWatchArray>;
+    /**
+     * Returns whether a user is watching a label. Choose the user by doing one
+     * of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watch status is returned.
+     * @path {GET} /wiki/rest/api/user/watch/label/{labelName}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence
+     */
+    isWatchingLabel({ labelName, key, username, accountId, }: {
+        /**
+         * The name of the label to be queried for whether the specified user is
+         * watching it.
+         */
+        labelName: 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<UserWatch>;
+    /**
+     * Returns whether a user is watching a space. Choose the user by
+     * doing one of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @returns Returned if the requested watch status is returned.
+     * @path {GET} /wiki/rest/api/user/watch/space/{spaceKey}
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:watcher:confluence
+     */
+    isWatchingSpace({ spaceKey, key, username, accountId, }: {
+        /**
+         * The key of the space to be queried for whether the specified user is
+         * watching it.
+         */
+        spaceKey: 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<UserWatch>;
+    /**
+     * Removes a user as a watcher from a piece of content. Choose the user by
+     * doing one of the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {DELETE} /wiki/rest/api/user/watch/content/{contentId}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    removeContentWatcher({ contentId, key, username, accountId, xAtlassianToken, }: {
+        /** The ID of the content to remove the watcher from. */
+        contentId: 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;
+        /**
+         * Note, you must add header when making a
+         * request, as this operation has XSRF protection.
+         */
+        xAtlassianToken: string;
+    }): Promise<void>;
+    /**
+     * Removes a user as a watcher from a label. Choose the user by doing one of
+     * the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {DELETE} /wiki/rest/api/user/watch/label/{labelName}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    removeLabelWatcher({ labelName, key, username, accountId, }: {
+        /** The name of the label to remove the watcher from. */
+        labelName: 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 a user as a watcher from a space. Choose the user by doing one of
+     * the following:
+     *
+     * - Specify a user via a query parameter: Use the `accountId` to identify the
+     * user.
+     * - Do not specify a user: The currently logged-in user will be used.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission if specifying a user, otherwise
+     * permission to access the Confluence site ('Can use' global permission).
+     *
+     * @path {DELETE} /wiki/rest/api/user/watch/space/{spaceKey}
+     * @scopes-current write:confluence-content
+     * @scopes-beta write:watcher:confluence
+     */
+    removeSpaceWatch({ spaceKey, key, username, accountId, }: {
+        /** The key of the space to remove the watcher from. */
+        spaceKey: 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>;
+    static initialize(): void;
+}