@atlassian-dc-mcp/confluence 0.1.4 → 0.2.0

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

@@ -0,0 +1,200 @@
+/* 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 LabelService {
+    /**
+     * Get list of labels matching the given label name, namespace, space (via space key) or owner.
+     * Returns a paginated list of labels matching the given label name, namespace, space (via space key) or owner.
+     * Leave query params empty to ignore.
+     *
+     * Example request URI(s):
+     * `http://example.com/confluence/rest/api/label/labels?spaceKey=MYS&namespace=global&limit=3`
+     * @param spaceKey The spaceKey to restrict by.
+     * @param owner The owner of the labels.
+     * @param start The start point of the collection to return.
+     * @param limit The limit of the number of labels to return, this may be restricted by fixed system limit.
+     * @param namespace The namespace of the labels.
+     * @param labelName The name of the label (excluding any prefix)
+     * @returns any Return a list of labels matching the given request.
+     * @throws ApiError
+     */
+    public static labels1(
+        spaceKey?: string,
+        owner?: string,
+        start?: string,
+        limit?: string,
+        namespace?: string,
+        labelName?: 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/label/labels',
+            query: {
+                'spaceKey': spaceKey,
+                'owner': owner,
+                'start': start,
+                'limit': limit,
+                'namespace': namespace,
+                'labelName': labelName,
+            },
+            errors: {
+                400: `Return a bad request error if the given label name is invalid`,
+                404: `Return a not found error if the given label name is not found`,
+            },
+        });
+    }
+    /**
+     * Get most popular labels
+     * Returns a paginated list of the most popular labels within a Confluence instance. This includes
+     * Labels used by Pages, Blog Posts, and other Content types. Labels are sorted
+     * based on number of occurrences from the most to the least used. Only global labels are considered in this list.
+     *
+     * Example request URI's:
+     * `https://example.com/confluence/rest/api/label/popular`
+     * `https://example.com/confluence/rest/api/label/popular?start=2&limit=1`
+     * @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 a JSON representation of a list of labels, or an empty list if no labels are found.
+     * @throws ApiError
+     */
+    public static popular(
+        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/label/popular',
+            query: {
+                'limit': limit,
+                'start': start,
+            },
+            errors: {
+                403: `If the calling user does not have permission to retrieve popular labels.`,
+            },
+        });
+    }
+    /**
+     * Get recently used labels
+     * Returns a paginated list of recently used labels within a Confluence instance. Labels are sorted
+     * from the most to the least recently used. Only global labels are considered in this list.
+     *
+     * Example request URI's:
+     * `https://example.com/confluence/rest/api/label/recent`
+     * `https://example.com/confluence/rest/api/label/recent?start=2&limit=1`
+     * @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 a JSON representation of a list of labels, or an empty list if no labels are found.
+     * @throws ApiError
+     */
+    public static recent(
+        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/label/recent',
+            query: {
+                'limit': limit,
+                'start': start,
+            },
+            errors: {
+                403: `If the calling user does not have permission to retrieve recently used labels.`,
+            },
+        });
+    }
+    /**
+     * Get related labels.
+     * Return a paginated list of labels related to the given label name sorted by frequency of use in descending order.
+     * The current process for identifying related labels solely
+     * examines global labels, but it may change in the future.
+     *
+     * Example request URI's:
+     * `https://example.com/confluence/rest/api/label/test_label_name/related`
+     * `https://example.com/confluence/rest/api/label/my:test_label_name/related?limit=200`
+     * @param labelName the name of the label (namespace prefixes permitted).
+     * @param start the start point of the collection to return.
+     * @param limit the maximum number of related labels to return. Default to be 100.
+     * @returns any Return a JSON representation of related labels to the given label name
+     * @throws ApiError
+     */
+    public static related(
+        labelName: string,
+        start?: string,
+        limit?: 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/label/{labelName}/related',
+            path: {
+                'labelName': labelName,
+            },
+            query: {
+                'start': start,
+                'limit': limit,
+            },
+            errors: {
+                400: `Return a bad request error if the given label name is invalid`,
+                404: `Return a not found error if the given label name is not found`,
+            },
+        });
+    }
+}
+
+

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

@@ -0,0 +1,75 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { LongTaskStatus } from '../models/LongTaskStatus.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class LongTaskService {
+    /**
+     * Get task by ID
+     * Returns information about a long-running task.
+     * @param id  the key of the task to be returned.
+     * @param expand a comma separated list of properties to expand on the task.
+     * @returns LongTaskStatus returns a full JSON representation of a long task.
+     * @throws ApiError
+     */
+    public static getTask(
+        id: string,
+        expand?: string,
+    ): CancelablePromise<LongTaskStatus> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/longtask/{id}',
+            path: {
+                'id': id,
+            },
+            query: {
+                'expand': expand,
+            },
+            errors: {
+                404: `Returned if there is no task with the given key, or if the calling user does not have permission to view it`,
+            },
+        });
+    }
+    /**
+     * Get tasks
+     * Returns information about all tracked long-running tasks.
+     * @param expand comma separated list of properties to expand on the tasks.
+     * @param limit the limit of the number of items to return, this may be restricted by fixed system limits
+     * @param start the start point of the collection to return.
+     * @returns any returns a full JSON representation of a list of long tasks.
+     * @throws ApiError
+     */
+    public static getTasks(
+        expand?: string,
+        limit?: string,
+        start?: string,
+    ): CancelablePromise<{
+        results?: Array<LongTaskStatus>;
+        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/longtask',
+            query: {
+                'expand': expand,
+                'limit': limit,
+                'start': start,
+            },
+        });
+    }
+}
+
+

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

@@ -0,0 +1,74 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { SearchResult } from '../models/SearchResult.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class SearchService {
+    /**
+     * Search for entities in confluence
+     * Search for entities in Confluence using the [Confluence Query Language (CQL)](https://developer.atlassian.com/confdev/confluence-rest-api/advanced-searching-using-cql). For example:
+     *
+     * Example request URI(s):
+     *
+     * - `http://localhost:8080/confluence/rest/api/search?cql=creator=currentUser()&type%20in%20(space,page,user)&cqlcontext={"spaceKey":"TST", "contentId":"55"}`
+     *
+     * - `http://localhost:8080/confluence/rest/api/search?cql=siteSearch~'example'%20AND%20label=docs&expand=content.space,space.homepage&limit=10`
+     * @param cqlcontext the execution context for CQL functions, provides current space key and content id. If this is not provided some CQL functions will not be available.
+     * @param expand the properties to expand on the search result, this may cause database requests for some properties
+     * @param includeArchivedSpaces whether to include content in archived spaces in the result, this defaults to false.
+     * @param limit the limit of the number of items to return, this may be restricted by fixed system limits.
+     * @param start he start point of the collection to return.
+     * @param excerpt the excerpt strategy to apply to the result, one of : indexed, highlight, none. This defaults to highlight.
+     * @param cql the CQL query see <a href='https://developer.atlassian.com/confdev/confluence-rest-api/advanced-searching-using-cql'>advanced searching in confluence using CQL</a>
+     * @param requestBody
+     * @returns any returns a full JSON representation of a list of search results.
+     * @throws ApiError
+     */
+    public static search1(
+        cqlcontext?: string,
+        expand?: string,
+        includeArchivedSpaces?: string,
+        limit?: string,
+        start?: string,
+        excerpt?: string,
+        cql?: string,
+        requestBody?: string,
+    ): CancelablePromise<{
+        results?: Array<SearchResult>;
+        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/search',
+            query: {
+                'cqlcontext': cqlcontext,
+                'expand': expand,
+                'includeArchivedSpaces': includeArchivedSpaces,
+                'limit': limit,
+                'start': start,
+                'excerpt': excerpt,
+                'cql': cql,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `returned if the query cannot be parsed`,
+            },
+        });
+    }
+}
+
+

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

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ServerInformation } from '../models/ServerInformation.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ServerInformationService {
+    /**
+     * Get server information
+     * Returns information about the current application build running on this instance.
+     * @returns ServerInformation The server build information.
+     * @throws ApiError
+     */
+    public static index2(): CancelablePromise<ServerInformation> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/server-information',
+            errors: {
+                401: `Returned if the calling User is not authenticated.`,
+            },
+        });
+    }
+}
+
+

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

@@ -0,0 +1,143 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ColorSchemeThemeBasedModel } from '../models/ColorSchemeThemeBasedModel.js';
+import type { SpaceColorSchemeTypeModel } from '../models/SpaceColorSchemeTypeModel.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class SpaceColorSchemeService {
+    /**
+     * Get Space color scheme type
+     * Get the current color scheme type used for a space, it can be global or custom
+     *
+     *
+     * @param spaceKey Space key of the space to request color scheme type for.
+     * @returns SpaceColorSchemeTypeModel Returns a color scheme type
+     * @throws ApiError
+     */
+    public static getColorSchemeType(
+        spaceKey: string,
+    ): CancelablePromise<SpaceColorSchemeTypeModel> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/space/{spaceKey}/color-scheme/type',
+            path: {
+                'spaceKey': spaceKey,
+            },
+            errors: {
+                403: `Returned if a space with the user for given space key is not space admin.`,
+                404: `Returned if a space with the given space key does not exist.`,
+            },
+        });
+    }
+    /**
+     * Update Space color scheme type
+     * Update the color scheme type used for a space, currently it can be global or custom
+     *
+     *
+     * @param spaceKey space key of the space to update color scheme type for.
+     * @param requestBody New color scheme type
+     * @returns SpaceColorSchemeTypeModel Returns the updated color scheme type
+     * @throws ApiError
+     */
+    public static updateColorSchemeType(
+        spaceKey: string,
+        requestBody?: SpaceColorSchemeTypeModel,
+    ): CancelablePromise<SpaceColorSchemeTypeModel> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/space/{spaceKey}/color-scheme/type',
+            path: {
+                'spaceKey': spaceKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Returned if space type is invalid in the request`,
+                403: `Returned if a space with the user is not space admin for the given space.`,
+                404: `Returned if a space with the given space key does not exist.`,
+            },
+        });
+    }
+    /**
+     * Get Space color scheme
+     * Get information about the current color scheme for a space
+     *
+     *
+     * @param spaceKey space key of the space to request color scheme for.
+     * @returns ColorSchemeThemeBasedModel Returns a full JSON representation of color scheme
+     * @throws ApiError
+     */
+    public static getSpaceColorScheme(
+        spaceKey: string,
+    ): CancelablePromise<ColorSchemeThemeBasedModel> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/rest/api/space/{spaceKey}/color-scheme',
+            path: {
+                'spaceKey': spaceKey,
+            },
+            errors: {
+                403: `Returned if a space with the user is not space admin for the given space.`,
+                404: `Returned if a space with the given space key does not exist.`,
+            },
+        });
+    }
+    /**
+     * Update Space color scheme
+     * Update the color scheme for a space
+     *
+     *
+     * @param spaceKey space key of the space to set color scheme for.
+     * @param requestBody New color scheme
+     * @returns ColorSchemeThemeBasedModel Returns a full JSON representation of color scheme
+     * @throws ApiError
+     */
+    public static updateSpaceColorScheme(
+        spaceKey: string,
+        requestBody?: ColorSchemeThemeBasedModel,
+    ): CancelablePromise<ColorSchemeThemeBasedModel> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/space/{spaceKey}/color-scheme',
+            path: {
+                'spaceKey': spaceKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Returned if there are invalid colors in the request`,
+                403: `Returned if a space with the user is not space admin for the given space.`,
+                404: `Returned if a space with the given space key does not exist.`,
+            },
+        });
+    }
+    /**
+     * Reset Space color scheme
+     * Reset the space color scheme to use global color scheme
+     *
+     *
+     * @param spaceKey Space key of the space to reset color scheme for.
+     * @returns ColorSchemeThemeBasedModel Returns a JSON representation of color scheme
+     * @throws ApiError
+     */
+    public static resetSpaceColorScheme(
+        spaceKey: string,
+    ): CancelablePromise<ColorSchemeThemeBasedModel> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/rest/api/space/{spaceKey}/color-scheme/reset',
+            path: {
+                'spaceKey': spaceKey,
+            },
+            errors: {
+                403: `Returned if a space with the user is not space admin for the given space.`,
+                404: `Returned if a space with the given space key does not exist.`,
+            },
+        });
+    }
+}
+
+