@atlassian-dc-mcp/confluence 0.1.4 → 0.3.0

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

@@ -0,0 +1,320 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ExampleMultipartFormData } from '../models/ExampleMultipartFormData.js';
+import type { FileInfo } from '../models/FileInfo.js';
+import type { JobDetails } from '../models/JobDetails.js';
+import type { SiteBackupJobDetails } from '../models/SiteBackupJobDetails.js';
+import type { SiteBackupSettings } from '../models/SiteBackupSettings.js';
+import type { SiteRestoreJobDetails } from '../models/SiteRestoreJobDetails.js';
+import type { SiteRestoreSettings } from '../models/SiteRestoreSettings.js';
+import type { SpaceBackupJobDetails } from '../models/SpaceBackupJobDetails.js';
+import type { SpaceBackupSettings } from '../models/SpaceBackupSettings.js';
+import type { SpaceRestoreJobDetails } from '../models/SpaceRestoreJobDetails.js';
+import type { SpaceRestoreSettings } from '../models/SpaceRestoreSettings.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class BackupAndRestoreService {
+    /**
+     * Cancel all queued jobs
+     * Cancels all queued jobs. Does not affect jobs that are being processed at the moment.
+     * @returns any Returns the number of cancelled jobs. If no jobs were cancelled, 0 is returned.
+     * Example response: `1`
+     * @throws ApiError
+     */
+    public static cancelAllQueuedJobs(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/backup-restore/jobs/clear-queue',
+            errors: {
+                403: `Returned if user doesn't have permission to cancel jobs`,
+            },
+        });
+    }
+    /**
+     * Cancel job
+     * Cancels the job. If the job is already cancelled or failed, the method will do nothing.
+     * @param jobId id of the backup/restore job
+     * @returns JobDetails Returns a JSON representation of the cancelled job.
+     * @throws ApiError
+     */
+    public static cancelJob(
+        jobId: string,
+    ): CancelablePromise<JobDetails> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/backup-restore/jobs/{jobId}/cancel',
+            path: {
+                'jobId': jobId,
+            },
+            errors: {
+                404: `Returned if job not found or user doesn't have permission to cancel it`,
+            },
+        });
+    }
+    /**
+     * Create site backup job
+     * Starts the new site backup job.
+     * @param requestBody Site backup settings
+     * @returns SiteBackupJobDetails Returns a JSON representation of the site backup job details.
+     * @throws ApiError
+     */
+    public static createSiteBackupJob(
+        requestBody?: SiteBackupSettings,
+    ): CancelablePromise<SiteBackupJobDetails> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/backup-restore/backup/site',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: ` Returned if invalid settings provided`,
+                409: `Returned if user doesn't have permission to create site backups`,
+            },
+        });
+    }
+    /**
+     * Create site restore job
+     * Starts the new site restore job.
+     * @param requestBody space restore settings
+     * @returns SiteRestoreJobDetails Returns a JSON representation of the site restore job.
+     * @throws ApiError
+     */
+    public static createSiteRestoreJob(
+        requestBody?: SiteRestoreSettings,
+    ): CancelablePromise<SiteRestoreJobDetails> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/backup-restore/restore/site',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: ` Returned if invalid filename provided`,
+                403: `Returned if user doesn't have permission to restore site`,
+            },
+        });
+    }
+    /**
+     * Create site restore job for upload backup file
+     * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867.
+     *
+     * Most client libraries have classes that make dealing with multipart posts simple.
+     *
+     * For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it.  This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
+     *
+     * The name of the multipart/form-data parameter that contains attachments must be "file".
+     *
+     * An example to attach the file:
+     *
+     * curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F  file=@myfile.zip http://myhost/rest/api/backup-restore/restore/space/upload
+     *
+     * .
+     * @param formData Backup file to be uploaded. Has to be a zip file.
+     * @returns SiteRestoreJobDetails Returns a JSON representation of the site restore job details.
+     * @throws ApiError
+     */
+    public static createSiteRestoreJobForUploadedBackupFile(
+        formData?: ExampleMultipartFormData,
+    ): CancelablePromise<SiteRestoreJobDetails> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/backup-restore/restore/site/upload',
+            formData: formData,
+            mediaType: 'multipart/form-data',
+            errors: {
+                400: ` Returned if the uploaded file is not a zip file`,
+                403: ` Returned if user doesn't have permission to restore space`,
+            },
+        });
+    }
+    /**
+     * Create space backup job
+     * Creates new space backup job and adds it to the queue.
+     * @param requestBody Space backup settings
+     * @returns SpaceBackupJobDetails Returns a JSON representation of the space backup job
+     * @throws ApiError
+     */
+    public static createSpaceBackupJob(
+        requestBody?: SpaceBackupSettings,
+    ): CancelablePromise<SpaceBackupJobDetails> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/backup-restore/backup/space',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Returned if invalid settings provided`,
+                403: `Returned if user doesn't have permission to create space backups`,
+                409: `Returned if backup with the same spaces selected is already in PROGRESS or QUEUED`,
+            },
+        });
+    }
+    /**
+     * Create space restore job
+     * Creates new space restore job and adds it to the queue.
+     * @param requestBody space restore settings
+     * @returns SpaceRestoreJobDetails Returns a JSON representation of the space restore job.
+     * @throws ApiError
+     */
+    public static createSpaceRestoreJob(
+        requestBody?: SpaceRestoreSettings,
+    ): CancelablePromise<SpaceRestoreJobDetails> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/backup-restore/restore/space',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: ` Returned if invalid filename provided`,
+                403: `Returned if user doesn't have permission to restore spaces`,
+            },
+        });
+    }
+    /**
+     * Create space restore job for upload backup file
+     * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867.
+     *
+     * Most client libraries have classes that make dealing with multipart posts simple.
+     *
+     * For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
+     *
+     * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it.  This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
+     *
+     * The name of the multipart/form-data parameter that contains attachments must be "file".
+     *
+     * An example to attach the file:
+     *
+     * curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F  file=@myfile.zip http://myhost/rest/api/backup-restore/restore/space/upload
+     *
+     * .
+     * @param formData backup file uploaded. Has to be a zip file.
+     * @returns SpaceRestoreJobDetails Returns a JSON representation of the space restore job details.
+     * @throws ApiError
+     */
+    public static createSpaceRestoreJobForUploadedBackupFile(
+        formData?: ExampleMultipartFormData,
+    ): CancelablePromise<SpaceRestoreJobDetails> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/backup-restore/restore/space/upload',
+            formData: formData,
+            mediaType: 'multipart/form-data',
+            errors: {
+                400: ` Returned if the uploaded file is not a zip file`,
+                403: ` Returned if user doesn't have permission to restore space`,
+            },
+        });
+    }
+    /**
+     * Download backup file
+     * Downloads the backup file for the given job. Requires site admin or space export permissions for all spaces included in the backup job.
+     * @param jobId id of the backup/restore job
+     * @returns JobDetails Returns a data stream of the backup file content.
+     * @throws ApiError
+     */
+    public static downloadBackupFile(
+        jobId: string,
+    ): CancelablePromise<JobDetails> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/backup-restore/jobs/{jobId}/download',
+            path: {
+                'jobId': jobId,
+            },
+            errors: {
+                404: `Returned if job not found or user doesn't have permissions for the job or the file is missing`,
+            },
+        });
+    }
+    /**
+     * Find jobs by filters
+     * Returns jobs based on the filters provided. The user must have permission to see the jobs.
+     * @param owner userName of user who had created a job.
+     * @param spaceKey the key of the Space the User is attempting to view.
+     * @param fromDate minimum job creation date. Supported date format is `yyyy-MM-ddTHH:mm:ss.SSSZ`
+     * @param jobStates list of job states. Acceptable values: "QUEUED", "PROCESSING", "FINISHED", "CANCELLING", "CANCELLED", "FAILED"
+     * @param toDate maximum job create date. Supported date format is `yyyy-MM-ddTHH:mm:ss.SSSZ`
+     * @param jobOperation job operation. Acceptable values: "BACKUP" and "RESTORE"
+     * @param limit amount of jobs that should be returned
+     * @param jobScope scope of the job. Acceptable values: "SPACE" and "SITE"
+     * @returns JobDetails Returns the List of backup/restore jobs visible to user based on the filter provided and the user's permissions.
+     * @throws ApiError
+     */
+    public static findJobs(
+        owner?: string,
+        spaceKey?: string,
+        fromDate?: string,
+        jobStates?: string,
+        toDate?: string,
+        jobOperation?: string,
+        limit?: string,
+        jobScope?: string,
+    ): CancelablePromise<Array<JobDetails>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/backup-restore/jobs',
+            query: {
+                'owner': owner,
+                'spaceKey': spaceKey,
+                'fromDate': fromDate,
+                'jobStates': jobStates,
+                'toDate': toDate,
+                'jobOperation': jobOperation,
+                'limit': limit,
+                'jobScope': jobScope,
+            },
+            errors: {
+                400: `Returned if invalid filter parameters were passed`,
+            },
+        });
+    }
+    /**
+     * Get files in restore directory
+     * returns list of information on files in conf-home/restore/(jobScope).
+     * @param jobScope name of type of restore job (SITE or SPACE or null), if null, all backup files are listed
+     * @returns FileInfo Returns a list of FileInfo objects, containing fileName, fileCreationTime, fileSize, and jobScope.
+     * @throws ApiError
+     */
+    public static getFiles(
+        jobScope?: string,
+    ): CancelablePromise<Array<FileInfo>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/backup-restore/restore/files',
+            query: {
+                'jobScope': jobScope,
+            },
+            errors: {
+                400: `Returned if user is not a system administrator`,
+            },
+        });
+    }
+    /**
+     * Get job by ID
+     * Get job by id. The user must be a sysadmin or the owner of the job.
+     * @param jobId id of the backup/restore job
+     * @returns JobDetails Returns a JSON representation of the backup/restore job
+     * @throws ApiError
+     */
+    public static getJob(
+        jobId: string,
+    ): CancelablePromise<JobDetails> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/backup-restore/jobs/{jobId}',
+            path: {
+                'jobId': jobId,
+            },
+            errors: {
+                400: ` Returned if jobId is null`,
+                403: ` Returned if job not found or user doesn't have permission to see it`,
+            },
+        });
+    }
+}
+
+

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

@@ -0,0 +1,70 @@
+/* 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 CategoryService {
+    /**
+     * Add a category to a space
+     * Adds a category the description of a given {@link Space} identified by spaceKey.
+     *
+     * Example request URI to add space category 'testCategory' to space with space key TEST:
+     *
+     * `https://example.com/confluence/rest/api/space/TEST/category/testCategory`
+     * @param spaceKey a string containing the key of the space
+     * @param labelName the name of the label to be added (do not include any prefix, team: prefix assumed)
+     * @returns void
+     * @throws ApiError
+     */
+    public static add(
+        spaceKey: string,
+        labelName: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/rest/api/space/{spaceKey}/category/{labelName}',
+            path: {
+                'spaceKey': spaceKey,
+                'labelName': labelName,
+            },
+            errors: {
+                401: `Returned if the calling user is not authenticated.`,
+                403: `If the calling user does not have permission to add any label to the given space.`,
+                404: `Returned if there is no space with the given spaceKey.`,
+            },
+        });
+    }
+    /**
+     * Remove a category from a space
+     * Removes a category from a space, identified by spaceKey.
+     *
+     * Example request URI:
+     * `https://example.com/confluence/rest/api/space/TEST/category/example-category`
+     * @param spaceKey The key of the space to remove the category from
+     * @param categoryName The name of the category to remove
+     * @returns void
+     * @throws ApiError
+     */
+    public static removeCategory(
+        spaceKey: string,
+        categoryName: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/rest/api/space/{spaceKey}/category/{categoryName}',
+            path: {
+                'spaceKey': spaceKey,
+                'categoryName': categoryName,
+            },
+            errors: {
+                401: `Returned if the calling user is not authenticated.`,
+                403: `Returned if the calling user does not have permission to edit the Space.`,
+                404: `Returned if there is no space with the given key`,
+            },
+        });
+    }
+}
+
+

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