@atlassian-dc-mcp/confluence 0.1.3 → 0.2.0

package/src/confluence-client/services/ContentRestrictionsService.ts

@@ -0,0 +1,176 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ContentRestriction } from '../models/ContentRestriction.js';
+import type { MockRestrictionsResponse } from '../models/MockRestrictionsResponse.js';
+import type { OperationRestriction } from '../models/OperationRestriction.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ContentRestrictionsService {
+    /**
+     * Get all restrictions by Operation
+     * Returns info about all restrictions by operation.
+     * @param id The id of the content
+     * @param expand A comma separated list of properties to expand on the content properties. Default value: group.
+     * @returns MockRestrictionsResponse Returns a JSON representation of the restrictions group by operations.
+     * @throws ApiError
+     */
+    public static byOperation(
+        id: string,
+        expand?: string,
+    ): CancelablePromise<MockRestrictionsResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/content/{id}/restriction/byOperation',
+            path: {
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+            },
+        });
+    }
+    /**
+     * Get all restrictions for given operation
+     * Returns info about all restrictions of given operation.
+     * @param operationKey key of the operation.
+     * @param id The id of the content
+     * @param expand Aa comma separated list of properties to expand on the content properties. Default value: group.
+     * @param limit pagination limit.
+     * @param start pagination start.
+     * @returns OperationRestriction Returns a JSON representation of the restrictions of given operation.
+     * @throws ApiError
+     */
+    public static forOperation(
+        operationKey: string,
+        id: string,
+        expand?: string,
+        limit?: string,
+        start?: string,
+    ): CancelablePromise<OperationRestriction> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/content/{id}/restriction/byOperation/{operationKey}',
+            path: {
+                'operationKey': operationKey,
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+                'limit': limit,
+                'start': start,
+            },
+        });
+    }
+    /**
+     * Get all view restriction both direct and inherited.
+     * Returns relevant view restriction both direct and inherited for a single content.
+     * @param id The id of the content
+     * @param expand A comma separated list of properties to expand on the content properties. Default value: relevantViewRestrictions
+     * @param limit pagination limit, Max 50 per page
+     * @param start pagination start.
+     * @returns MockRestrictionsResponse Returns a JSON representation of the restrictions group by operations.
+     * @throws ApiError
+     */
+    public static relevantViewRestrictions(
+        id: string,
+        expand?: string,
+        limit?: string,
+        start?: string,
+    ): CancelablePromise<MockRestrictionsResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/content/{id}/restriction/relevantViewRestrictions',
+            path: {
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+                'limit': limit,
+                'start': start,
+            },
+        });
+    }
+    /**
+     * Update restrictions
+     * Sets all the restrictions specified to a piece of content identified by `contentId`. Setting per-content restrictions is currently allowed for Pages or BlogPosts only.
+     *
+     * Example request URI:
+     *
+     * `http://example.com/confluence/rest/content/1234567/restriction?expand=`
+     *
+     * The payload uses the same schema as returned by the GET requests from `/rest/api/content/{id}/restriction/byOperation*` which can be used as a template but is not necessary.
+     *
+     * Example request for a single content restriction:
+     *
+     * ```json
+     * [ { "operation": "update", "restrictions": { "user": [ { "type": "known", "username": "admin" } ] } } ]
+     * ```
+     *
+     * Example request for updating two ContentRestrictions:
+     *
+     * ```json
+     * [ { "operation": "update", "restrictions": { "user": [ { "type": "known", "username": "admin" } ] } }, { "operation": "read", "restrictions": { "user": [ { "type": "known", "username": "fred" } ] } } ]
+     * ```
+     *
+     * Rules for using this method:
+     *
+     * - The provided ContentRestrictions will overwrite any existing restrictions on the Content for the corresponding operations.
+     * - If the provided `ContentRestriction` lacks any supported operations, the restrictions for the operations will not be altered.
+     * - Setting `users` and/or `groups` map entries as empty arrays will remove the corresponding content restrictions.
+     * - Missing `users` and/or `groups` map entries means the corresponding operation's user/group content restrictions won't be changed.
+     * - Modifying restrictions to revoke the requesting user's access is prohibited.
+     * @param id The id of the content
+     * @param expand A comma separated list of properties to expand in the response. Default is <code>restrictions.user, restrictions.group</code> Default value: group.
+     * @param limit pagination limit.
+     * @param start pagination start.
+     * @param requestBody
+     * @returns any Returns a full JSON representation of the restrictions present directly on piece of content after the update operation.
+     * @throws ApiError
+     */
+    public static updateRestrictions(
+        id: string,
+        expand?: string,
+        limit?: string,
+        start?: string,
+        requestBody?: Array<ContentRestriction>,
+    ): CancelablePromise<{
+        results?: Array<OperationRestriction>;
+        totalCount?: number;
+        start?: number;
+        limit?: number;
+        size?: number;
+        _links?: {
+            base?: string;
+            context?: string;
+            self?: string;
+            next?: string;
+            prev?: string;
+        };
+    }> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/content/{id}/restriction',
+            path: {
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+                'limit': limit,
+                'start': start,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Returned if any of the above validation rules are violated.`,
+                401: `Returned if the calling user is not authenticated.`,
+                403: `Returned if the calling user does not have permission to edit the restrictions.`,
+                404: `Returned if there is no content with the given id, or if the calling user does not have permission to view the content.`,
+            },
+        });
+    }
+}
+
+

package/src/confluence-client/services/ContentVersionService.ts

@@ -0,0 +1,37 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ContentVersionService {
+    /**
+     * Delete content history
+     * Delete a historical version of a page or a blogpost. Current user must have edit permission on content, or it will throw a permission exception.
+     * @param id The id of the content
+     * @param versionNumber version number starts from 1 up to current version.
+     * @returns void
+     * @throws ApiError
+     */
+    public static deleteContentHistory(
+        id: string,
+        versionNumber: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/rest/api/content/{id}/version/{versionNumber}',
+            path: {
+                'id': id,
+                'versionNumber': versionNumber,
+            },
+            errors: {
+                400: `Returned if versionNumber is less than 1, does not exist or has already been deleted.`,
+                403: `Returned if the calling user doesn't have permission to edit the content.`,
+                404: `Returned if the contentId cannot be found.`,
+            },
+        });
+    }
+}
+
+

package/src/confluence-client/services/ContentWatchersService.ts

@@ -0,0 +1,57 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { User } from '../models/User.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ContentWatchersService {
+    /**
+     * Fetch users watching a given content
+     * Returns a paginated list of Users watching the given Content identified by contentId. Only a Confluence Administrator or Space Administrator can perform this action.
+     * @param contentId the ID of the Content the User is attempting to view the watchers for.
+     * @param limit The limit of the number of users to return, this may be restricted by fixed system limit.
+     * @param start The start point of the collection to return.
+     * @returns any The list of Users watching the Content.
+     * @throws ApiError
+     */
+    public static index(
+        contentId: string,
+        limit?: string,
+        start?: string,
+    ): CancelablePromise<{
+        results?: Array<User>;
+        totalCount?: number;
+        start?: number;
+        limit?: number;
+        size?: number;
+        _links?: {
+            base?: string;
+            context?: string;
+            self?: string;
+            next?: string;
+            prev?: string;
+        };
+    }> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/content/{contentId}/watchers',
+            path: {
+                'contentId': contentId,
+            },
+            query: {
+                'limit': limit,
+                'start': start,
+            },
+            errors: {
+                400: `Returned if the requested Content is not of type BlogPost or Page.`,
+                401: `Returned if the calling User is not authenticated.`,
+                403: `Returned if the calling User is not a Confluence Administrator or Space Administrator.`,
+                404: `Returned if the Content does not exist.`,
+            },
+        });
+    }
+}
+
+

package/src/confluence-client/services/DefaultService.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class DefaultService {
+    /**
+     * @deprecated
+     * @returns any default response
+     * @throws ApiError
+     */
+    public static getAuditRecords(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/audit',
+        });
+    }
+}
+
+

package/src/confluence-client/services/GlobalColorSchemeService.ts

@@ -0,0 +1,80 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ColorSchemeThemeBasedModel } from '../models/ColorSchemeThemeBasedModel.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class GlobalColorSchemeService {
+    /**
+     * Get default global color scheme
+     * Get default color scheme for the instance
+     *
+     *
+     * @returns ColorSchemeThemeBasedModel Returns a full JSON representation of color scheme including light and dark theme
+     * @throws ApiError
+     */
+    public static getDefaultColorScheme(): CancelablePromise<ColorSchemeThemeBasedModel> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/color-scheme/default',
+        });
+    }
+    /**
+     * Get global color scheme
+     * Get information about the current color scheme for the instance
+     *
+     *
+     * @returns ColorSchemeThemeBasedModel Returns a full JSON representation of color scheme including light and dark theme
+     * @throws ApiError
+     */
+    public static getGlobalColorScheme(): CancelablePromise<ColorSchemeThemeBasedModel> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/color-scheme',
+        });
+    }
+    /**
+     * Set global color scheme
+     * Update the current color scheme of the instance
+     *
+     *
+     * @param requestBody New color scheme
+     * @returns ColorSchemeThemeBasedModel Returns a full JSON representation of the updated color scheme
+     * @throws ApiError
+     */
+    public static updateColorScheme(
+        requestBody?: ColorSchemeThemeBasedModel,
+    ): CancelablePromise<ColorSchemeThemeBasedModel> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/color-scheme',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Returned if there are invalid colors in the request`,
+                403: `Returned if the user is not a site admin`,
+            },
+        });
+    }
+    /**
+     * Reset global color scheme
+     * Reset the global color scheme colors to default
+     *
+     *
+     * @returns ColorSchemeThemeBasedModel Returns a full JSON representation of color scheme
+     * @throws ApiError
+     */
+    public static resetGlobalColorScheme(): CancelablePromise<ColorSchemeThemeBasedModel> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/color-scheme/reset',
+            errors: {
+                403: `Returned if the user is not a site admin`,
+            },
+        });
+    }
+}
+
+