@atlassian-dc-mcp/confluence 0.1.4 → 0.2.0

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

@@ -0,0 +1,175 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Content } from '../models/Content.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ChildContentService {
+    /**
+     * Get children of content
+     * Returns a map of the direct children of a piece of Content. Content can have multiple types of children. For example, a Page can have children that are also Pages, but it can also have Comments and Attachments.
+     *
+     * The types of the children returned is specified by the `expand` query parameter in the request. This parameter can include expands for multiple child types. If no types are included in the `expand` parameter, the map returned will just list the child types that are available to be expanded for the content referenced by the `id` path parameter.
+     * @param id The id of the content to retrieve children for
+     * @param expand a comma separated list of properties to expand on the children
+     * @param limit how many items should be returned after the start index
+     * @param start the index of the first item within the result set that should be returned
+     * @param parentVersion
+     * @returns any Returned if the children are successfully retrieved. The response body contains a JSON map representing multiple ordered collections of content children, keyed by content type.
+     * @throws ApiError
+     */
+    public static children(
+        id: string,
+        expand?: string,
+        limit?: string,
+        start?: string,
+        parentVersion?: number,
+    ): CancelablePromise<{
+        results?: Array<Content>;
+        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/{id}/child',
+            path: {
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+                'limit': limit,
+                'start': start,
+                'parentVersion': parentVersion,
+            },
+            errors: {
+                404: ` Returned if there is no content with the given id, or if the calling user does not have permission to view the content.`,
+            },
+        });
+    }
+    /**
+     * Get children of content by type
+     * Returns the direct children of a piece of Content, limited to a single child type.The types of the children returned is specified by the "type" path parameter in the request.
+     * @param id The id of the content to retrieve children for
+     * @param type a  content type to filter children on.
+     * @param expand a comma separated list of properties to expand on the children
+     * @param limit how many items should be returned after the start index
+     * @param start the index of the first item within the result set that should be returned
+     * @param parentVersion
+     * @returns any Returns a JSON map representing multiple ordered collections of content children, keyed by content type
+     * @throws ApiError
+     */
+    public static childrenOfType(
+        id: string,
+        type: string,
+        expand?: string,
+        limit?: string,
+        start?: string,
+        parentVersion?: number,
+    ): CancelablePromise<{
+        results?: Array<Content>;
+        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/{id}/child/{type}',
+            path: {
+                'id': id,
+                'type': type,
+            },
+            query: {
+                'expand': expand,
+                'limit': limit,
+                'start': start,
+                'parentVersion': parentVersion,
+            },
+            errors: {
+                404: ` Returned if there is no content with the given id, or if the calling user does not have permission to view the content.`,
+            },
+        });
+    }
+    /**
+     * Get comments of content
+     * Returns the comments of a piece of Content. Example request URI(s):
+     *
+     * - `http://example.com/confluence/rest/api/content/1234/child/comment`
+     * - `http://example.com/confluence/rest/api/content/1234/child/comment?expand=body.view`
+     * - `http://example.com/confluence/rest/api/content/1234/child/comment?start=20&limit=10`
+     * - `http://example.com/confluence/rest/api/content/1234/child/comment?location=footer&location=inline&location=resolved`
+     * - `http://example.com/confluence/rest/api/content/1234/child/comment?expand=extensions.inlineProperties,extensions.resolution`
+     * @param id The id of the content to retrieve children for
+     * @param expand a comma separated list of properties to expand on the children
+     * @param depth (optional, default: "") the depth of the comments. Possible values are: "" (ROOT only), "all"
+     * @param limit how many items should be returned after the start index
+     * @param start the index of the first item within the result set that should be returned
+     * @param location (optional, default: "" means all) the location of the comments. Possible values are: "inline", "footer", "resolved".
+     * You can define multiple location params. The results will be the comments matched by any location.
+     * @param parentVersion
+     * @returns any Returns a JSON map representing multiple ordered collections of content children, keyed by content type
+     * @throws ApiError
+     */
+    public static commentsOfContent(
+        id: string,
+        expand?: string,
+        depth?: string,
+        limit?: string,
+        start?: string,
+        location?: string,
+        parentVersion?: number,
+    ): CancelablePromise<{
+        results?: Array<Content>;
+        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/{id}/child/comment',
+            path: {
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+                'depth': depth,
+                'limit': limit,
+                'start': start,
+                'location': location,
+                'parentVersion': parentVersion,
+            },
+            errors: {
+                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/ClusterInformationService.ts

@@ -0,0 +1,53 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { NodeStatus } from '../models/NodeStatus.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ClusterInformationService {
+    /**
+     * Get node statuses in a cluster
+     * Returns a paginated list of information about each node in a cluster. Example request URI(s):
+     * - `https://example.com/confluence/rest/api/cluster/nodes`
+     * - `https://example.com/confluence/rest/api/cluster/nodes?start=0&limit=10`
+     *
+     * @param limit The limit of the number of node statuses to return, this may be restricted by fixed system limit.
+     * @param start The start point of the collection to return.
+     * @returns any Return a list of nodes and their status.
+     * @throws ApiError
+     */
+    public static getClusterNodeStatuses(
+        limit?: string,
+        start?: string,
+    ): CancelablePromise<{
+        results?: Array<NodeStatus>;
+        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/cluster/nodes',
+            query: {
+                'limit': limit,
+                'start': start,
+            },
+            errors: {
+                401: `Returned if user has not been authenticated.`,
+                403: `Returned if user does not have permission to view cluster information.`,
+            },
+        });
+    }
+}
+
+

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

@@ -0,0 +1,74 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Content } from '../models/Content.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ContentBlueprintService {
+    /**
+     * Publish shared draft
+     * Publishes a shared draft of a Content created from a ContentBlueprint.
+     * @param draftId the id of the draft
+     * @param expand A comma separated list of properties to expand on the content. Default value: <code>body.storage,history,space,version,ancestors</code>
+     * @param status only support 'draft' status for now.
+     * @param requestBody he content to be created, where the status of the included content is "current",
+     * and the content has an ID (which will be the draft ID)
+     * @returns Content returns a JSON representation of the content
+     * @throws ApiError
+     */
+    public static publishSharedDraft(
+        draftId: string,
+        expand?: string,
+        status?: string,
+        requestBody?: Content,
+    ): CancelablePromise<Content> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/content/blueprint/instance/{draftId}',
+            path: {
+                'draftId': draftId,
+            },
+            query: {
+                'expand': expand,
+                'status': status,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Publish legacy draft
+     * Publishes a legacy draft of a Content created from a ContentBlueprint.
+     * @param draftId the id of the draft
+     * @param expand A comma separated list of properties to expand on the content. Default value: <code>body.storage,history,space,version,ancestors</code>
+     * @param status only support 'draft' status for now.
+     * @param requestBody The content to be created, where the status of the included content is "current",
+     * and the content has an ID (which will be the draft ID)
+     * @returns Content returns a JSON representation of the content
+     * @throws ApiError
+     */
+    public static publishLegacyDraft(
+        draftId: string,
+        expand?: string,
+        status?: string,
+        requestBody?: Content,
+    ): CancelablePromise<Content> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/content/blueprint/instance/{draftId}',
+            path: {
+                'draftId': draftId,
+            },
+            query: {
+                'expand': expand,
+                'status': status,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+
+

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

@@ -0,0 +1,49 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ContentBody } from '../models/ContentBody.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ContentBodyService {
+    /**
+     * Convert body representation
+     * Converts between content body representations. Not all representations can be converted to/from other formats. Supported conversions:
+     *
+     * - `storage -> view,export_view,styled_view,editor`
+     * - `editor -> storage`
+     * - `view -> None`
+     * - `export_view -> None`
+     * - `styled_view -> None`
+     *
+     * Example request URI(s):
+     *
+     * - `http://example.com/confluence/rest/api/contentbody/convert/view`
+     * @param to the representation to convert to.
+     * @param expand A comma separated list of properties to expand on the content. Default value: <code>body.storage,history,space,version,ancestors</code>
+     * @param requestBody the body to convert from
+     * @returns ContentBody returns the converted body
+     * @throws ApiError
+     */
+    public static convert(
+        to: string,
+        expand?: string,
+        requestBody?: ContentBody,
+    ): CancelablePromise<ContentBody> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/contentbody/convert/{to}',
+            path: {
+                'to': to,
+            },
+            query: {
+                'expand': expand,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}
+
+

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

@@ -0,0 +1,119 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Content } from '../models/Content.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ContentDescendantService {
+    /**
+     * Get Descendants
+     * Returns a map of the descendants of a piece of Content. Content can have multiple types of descendants - for example a Page can have descendants that are also Pages, but it can also have Comments and Attachments.
+     *
+     * The ContentType(s) of the descendants returned is specified by the `expand` query parameter in the request - this parameter can include expands for multiple descendant types. If no types are included in the expand parameter, the map returned will just list the descendant types that are available to be expanded for the Content referenced by the `id` path parameter.
+     *
+     * Currently the only supported descendants are comment descendants of non-comment Content.
+     *
+     * Example request URI(s):
+     *
+     * `http://example.com/confluence/rest/api/content/1234/descendant`
+     *
+     * `http://example.com/confluence/rest/api/content/1234/descendant?expand=comment.body.VIEW`
+     *
+     * `http://example.com/confluence/rest/api/content/1234/descendant?expand=comment`
+     * @param id the ID of the Content the User is attempting to view the descendants for.
+     * @param expand  a comma separated list of properties to expand on the descendants.
+     * @returns any Returns a JSON map representing multiple ordered collections of content descendants,keyed by content type.
+     * @throws ApiError
+     */
+    public static descendants(
+        id: string,
+        expand?: string,
+    ): CancelablePromise<{
+        results?: Array<Content>;
+        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/{id}/descendant',
+            path: {
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+            },
+            errors: {
+                404: `Returned if there is no content with the given id, or if the calling user does not have permission to view the content.`,
+            },
+        });
+    }
+    /**
+     * Get descendants of type
+     * Returns the direct descendants of a piece of Content. The ContentType(s) of the descendants returned is specified by the `type` path parameter in the request. Currently the only supported descendants are comment descendants of non-comment Content.
+     *
+     * Example request URI(s):
+     *
+     * `http://example.com/confluence/rest/api/content/1234/descendant/comment`
+     *
+     * `http://example.com/confluence/rest/api/content/1234/descendant/comment?expand=body.VIEW`
+     *
+     * `http://example.com/confluence/rest/api/content/1234/descendant/comment?start=20&limit=10`
+     * @param id the ID of the Content the User is attempting to view the descendants for.
+     * @param type  content type to filter descendants on.
+     * @param expand a comma separated list of properties to expand on the descendants.
+     * @param limit  (optional, default: site limit) how many items should be returned after the start index.
+     * @param start (optional, default: 0) the index of the first item within the result set that should be returned.
+     * @returns any Returns a JSON map representing multiple ordered collections of content descendants, keyed by content type.
+     * @throws ApiError
+     */
+    public static descendantsOfType(
+        id: string,
+        type: string,
+        expand?: string,
+        limit?: string,
+        start?: string,
+    ): CancelablePromise<{
+        results?: Array<Content>;
+        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/{id}/descendant/{type}',
+            path: {
+                'id': id,
+                'type': type,
+            },
+            query: {
+                'expand': expand,
+                'limit': limit,
+                'start': start,
+            },
+            errors: {
+                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/ContentLabelsService.ts

@@ -0,0 +1,151 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Label } from '../models/Label.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ContentLabelsService {
+    /**
+     * Get labels
+     * Returns the list of labels on a piece of Content. Example request URI(s):
+     *
+     * - `http://example.com/confluence/rest/api/content/1234/label`
+     * - `http://example.com/confluence/rest/api/content/1234/label?prefix=global&start=0&limit=200`
+     * @param id the id of the content to get the labels for
+     * @param prefix the prefixes to filter the labels with.
+     * @param limit the limit of the number of labels to return, this may be restricted by fixed system limits
+     * @param start he start point of the collection to return.
+     * @returns any returns a JSON representation of the existing labels on the content with the given id
+     * @throws ApiError
+     */
+    public static labels(
+        id: string,
+        prefix?: string,
+        limit?: string,
+        start?: string,
+    ): CancelablePromise<{
+        results?: Array<Label>;
+        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/{id}/label',
+            path: {
+                'id': id,
+            },
+            query: {
+                'prefix': prefix,
+                'limit': limit,
+                'start': start,
+            },
+            errors: {
+                404: ` Returned if there is no content with the given id, or if the calling user does not have permission to view the content.`,
+            },
+        });
+    }
+    /**
+     * Add Labels
+     * Adds a list of labels to the specified content. The body is the json representation of the list.
+     * @param id the id of the content to get the labels for
+     * @param requestBody a single label object or a list of labels to add
+     * @returns any returns a JSON representation of the existing and added labels on the content with the given id, or a 404 NOT FOUND if there is no content with the given id or if the user is not permitted.  An empty list will be returned if there are no labels on the given content
+     * @throws ApiError
+     */
+    public static addLabels(
+        id: string,
+        requestBody?: Label,
+    ): CancelablePromise<{
+        results?: Array<Label>;
+        totalCount?: number;
+        start?: number;
+        limit?: number;
+        size?: number;
+        _links?: {
+            base?: string;
+            context?: string;
+            self?: string;
+            next?: string;
+            prev?: string;
+        };
+    }> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/content/{id}/label',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                404: `Returned if there is no content with the given id, or if the calling user does not have permission to view the content.`,
+            },
+        });
+    }
+    /**
+     * Delete label with query param
+     * Deletes a labels to the specified content.
+     * @param id the id of the content to get the labels for
+     * @param name the name of the label to be removed from the content
+     * @returns void
+     * @throws ApiError
+     */
+    public static deleteLabelWithQueryParam(
+        id: string,
+        name?: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/rest/api/content/{id}/label',
+            path: {
+                'id': id,
+            },
+            query: {
+                'name': name,
+            },
+            errors: {
+                403: ` Returned if user has view permission, but no edit permission to the content.permission to the content.`,
+                404: `Returned if content or label doesn't exist, or calling user doesn't have view permission to the content.permission to the content.`,
+            },
+        });
+    }
+    /**
+     * Delete label
+     * Deletes a labels to the specified content. The body is the json representation of the list. When calling this method through REST the label parameter doesn't accept `/` characters in label names, because of security constraints. For this case please use the query parameter version of this method (`/content/{id}/label?name={label}`)
+     * @param id the id of the content to get the labels for
+     * @param label the name of the label to be removed from the content
+     * @returns void
+     * @throws ApiError
+     */
+    public static deleteLabel(
+        id: string,
+        label: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/rest/api/content/{id}/label/{label}',
+            path: {
+                'id': id,
+                'label': label,
+            },
+            errors: {
+                400: `Returned if trying to delete a label with "/" in the name.permission to the content.`,
+                403: `Returned if user has view permission, but no edit permission to the content.permission to the content.`,
+                404: `Returned if content or label doesn't exist, or calling user doesn't have view permission to the content.`,
+            },
+        });
+    }
+}
+
+