@atlassian-dc-mcp/confluence 0.1.4 → 0.3.0

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.`,
+            },
+        });
+    }
+}
+
+

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

@@ -0,0 +1,205 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { JsonContentProperty } from '../models/JsonContentProperty.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ContentPropertyService {
+    /**
+     * Find all content properties
+     * Returns a paginated list of content properties. Example request URI(s):
+     *
+     * - `http://example.com/confluence/rest/api/content/1234/property?expand=content,version`
+     * @param id the id of the content
+     * @param expand a comma separated list of properties to expand on the content properties. Default value: <code>version</code>.
+     * @param limit the limit of the number of labels to return, this may be restricted by fixed system limits
+     * @param start the start point of the collection to return.
+     * @returns any returns a JSON representation of the content properties, or a 404 NOT FOUND if there is no content with the given id or if the user is not permitted..
+     * @throws ApiError
+     */
+    public static findAll(
+        id: string,
+        expand?: string,
+        limit?: string,
+        start?: string,
+    ): CancelablePromise<{
+        results?: Array<JsonContentProperty>;
+        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}/property',
+            path: {
+                'id': id,
+            },
+            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.`,
+            },
+        });
+    }
+    /**
+     * Create a content property
+     * Creates a new content property.
+     * @param id the id of the content
+     * @param requestBody content property to be created.
+     * @returns JsonContentProperty Returns a full JSON representation of the content property.
+     * @throws ApiError
+     */
+    public static create1(
+        id: string,
+        requestBody?: JsonContentProperty,
+    ): CancelablePromise<JsonContentProperty> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/content/{id}/property',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: ` Returned if the given property has a different ContentId to the one in the path, or
+                if the content already has a value with the given key, or the value is missing, or the value is too long.`,
+                403: ` Returned if the user does not have permission to edit the content with the given ContentId.`,
+                413: `Returned if the value is too long.`,
+            },
+        });
+    }
+    /**
+     * Find content property by key
+     * Returns a content property. Example request URI(s):
+     *
+     * - `http://example.com/confluence/rest/api/content/1234/property/example-property-key?expand=content,version`
+     * @param id the id of the content
+     * @param key the key of the content property. Required.
+     * @param expand a comma separated list of properties to expand on the content properties. Default value: <code>version</code>.
+     * @param limit the limit of the number of labels to return, this may be restricted by fixed system limits
+     * @returns JsonContentProperty returns a JSON representation of the content property.
+     * @throws ApiError
+     */
+    public static findByKey(
+        id: string,
+        key: string,
+        expand?: string,
+        limit?: string,
+    ): CancelablePromise<JsonContentProperty> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/content/{id}/property/{key}',
+            path: {
+                'id': id,
+                'key': key,
+            },
+            query: {
+                'expand': expand,
+                'limit': limit,
+            },
+            errors: {
+                404: `Returned if there is no content with the given id, or no property with the given key, or if the calling user does not have permission to view the content.`,
+            },
+        });
+    }
+    /**
+     * Update content property
+     * Updates a content property. The body contains the representation of the content property. Must include the property id, and the new version number. Attempts to create a new content property if the given version number is `1`
+     * @param id the id of the content
+     * @param key the key of the content property. Required.
+     * @param expand a comma separated list of properties to expand on the content properties. Default value: <code>version</code>.
+     * @param requestBody the content property being updated
+     * @returns JsonContentProperty returns  a JSON representation of the content property, or a 404 NOT FOUND if there is no content with the given id, or no property with the given key, or if the user is not permitted.
+     * @throws ApiError
+     */
+    public static update1(
+        id: string,
+        key: string,
+        expand?: string,
+        requestBody?: JsonContentProperty,
+    ): CancelablePromise<JsonContentProperty> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/content/{id}/property/{key}',
+            path: {
+                'id': id,
+                'key': key,
+            },
+            query: {
+                'expand': expand,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Returned if the given property has a different ContentId to the one in the path, or if the property has a different key to the one in the path, or the value is missing, or the value is too long.`,
+                403: `Returned if the user does not have permission to edit the content with the given ContentId.`,
+                404: `eturned if there is no content with the given id, or no property with the given key, or if the calling user does not have permission to view the content.`,
+                409: `Returned if the given version is does not match the expected target version of the updated property.`,
+                413: `Returned if the value is too long.`,
+            },
+        });
+    }
+    /**
+     * @param id the id of the content
+     * @param key
+     * @param requestBody
+     * @returns JsonContentProperty default response
+     * @throws ApiError
+     */
+    public static create2(
+        id: string,
+        key: string,
+        requestBody?: JsonContentProperty,
+    ): CancelablePromise<JsonContentProperty> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/content/{id}/property/{key}',
+            path: {
+                'id': id,
+                'key': key,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete content property
+     * Deletes a content property.
+     * @param id the id of the content
+     * @param key the key of the content property. Required.
+     * @returns void
+     * @throws ApiError
+     */
+    public static delete2(
+        id: string,
+        key: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/rest/api/content/{id}/property/{key}',
+            path: {
+                'id': id,
+                'key': key,
+            },
+            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.`,
+            },
+        });
+    }
+}
+
+