import type { Content } from '../models/Content.js'; import type { LongTaskSubmission } from '../models/LongTaskSubmission.js'; import type { PersonalSpaceDetailsForCreation } from '../models/PersonalSpaceDetailsForCreation.js'; import type { Space } from '../models/Space.js'; import type { CancelablePromise } from '../core/CancelablePromise.js'; export declare class SpaceService { /** * Archive space * Archive the given Space identified by spaceKey. This method is idempotent i.e., if the Space is already archived then no action will be taken. * @param spaceKey the key of the space to update. * @returns void * @throws ApiError */ static archive(spaceKey: string): CancelablePromise; /** * Get contents in space * Returns the content in this given space. * * Example request URI: * * `http://example.com/confluence/rest/api/space/TEST/content?expand=history` * @param spaceKey the key of the space to update. * @param expand a comma separated list of properties to expand on the space. * @param depth a string indicating if all content, or just the root content of the space is returned. Default value: all. Valid values: all, root. * @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 full JSON representation of a piece of content. * @throws ApiError */ static contents(spaceKey: string, expand?: string, depth?: string, limit?: string, start?: string): CancelablePromise<{ results?: Array; totalCount?: number; start?: number; limit?: number; size?: number; _links?: { base?: string; context?: string; self?: string; next?: string; prev?: string; }; }>; /** * Get trash contents of space * Returns the trash contents in this given space. * * Example request URI: * * `http://example.com/confluence/rest/api/space/TEST/trash?limit=100&cursor=content:false:612345` * @param spaceKey the key of the space to update. * @param cursor the identifier which is used to skip results from a previous query when paginating. Cursor is empty in first request, to move forward or backward use cursor provided in response. * @param expand a comma separated list of properties to expand on the space. * @param limit the limit of the number of labels to return, this may be restricted by fixed system limits. * @returns any Returns an array of full JSON representations of trash contents. * @throws ApiError */ static contentsWithType(spaceKey: string, cursor?: string, expand?: string, limit?: string): CancelablePromise<{ nextCursor?: string; prevCursor?: string; results?: Array; totalCount?: number; cursor?: string; limit?: number; size?: number; _links?: { base?: string; context?: string; self?: string; next?: string; prev?: string; }; }>; /** * Remove all trash contents * Remove all content from the trash in the given space, deleting them permanently.Example request URI: * * `http://example.com/confluence/rest/api/space/TEST/trash` * @param spaceKey the key of the space to update. * @returns void * @throws ApiError */ static trash(spaceKey: string): CancelablePromise; /** * Get contents by type * Returns the content in this given space with the given type. * * Example request URI: * * `http://example.com/confluence/rest/api/space/TEST/content/page?expand=history` * @param spaceKey the key of the space to update. * @param type the type of content to return with the space. Valid values: page, blogpost. * @param expand a comma separated list of properties to expand on the space. * @param depth a string indicating if all content, or just the root content of the space is returned. Default value: all. Valid values: all, root. * @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 full JSON representation of a piece of content. * @throws ApiError */ static contentsWithType1(spaceKey: string, type: string, expand?: string, depth?: string, limit?: string, start?: string): CancelablePromise<{ results?: Array; totalCount?: number; start?: number; limit?: number; size?: number; _links?: { base?: string; context?: string; self?: string; next?: string; prev?: string; }; }>; /** * Creates the personal Space for self. * Creates a personal space for self. * * Example request URI: * * `http://example.com/confluence/rest/api/space/personal` * @param requestBody The personal space to be created * @returns Space Returns a full JSON representation of a space. * @throws ApiError */ static createPersonalSpace1(requestBody: PersonalSpaceDetailsForCreation): CancelablePromise; /** * Create private space * Creates a new private Space, viewable only by its creator. The incoming Space does not include an id, but must include a Key and Name, and should include a Description. * @param requestBody The space to be created * @returns Space Returns a full JSON representation of a space. * @throws ApiError */ static createPrivateSpace(requestBody: Space): CancelablePromise; /** * Get spaces by key * Returns information about a number of spaces. * * Example request URI(s): * * `http://example.com/confluence/rest/api/space?spaceKey=TST&spaceKey=ds` * @param spaceKeySingle * @param start the start point of the collection to return. * @param label filter the list of spaces returned by label. * @param favourite filter the list of spaces returned by favourites. * @param type filter the list of spaces returned by type (global, personal). * @param spaceKey the key of the space to fetch information from. * @param spaceId * @param expand a comma separated list of properties to expand on the spaces. * @param hasRetentionPolicy filter the list of spaces returned by retention policy. * @param limit the limit of the number of spaces to return, this may be restricted by fixed system limits * @param spaceKeys the keys of the spaces to fetch information from. * @param contentLabel filter the list of spaces returned by content containing provided label. * @param spaceIds the ids of the spaces to fetch information from. Cannot be used in conjunction with spaceKey(s) * @param status filter the list of spaces returned by status (current, archived). * @param requestBody * @returns any Returns an array of full JSON representations of found space. * @throws ApiError */ static spaces(spaceKeySingle?: string, start?: string, label?: string, favourite?: string, type?: string, spaceKey?: string, spaceId?: Array, expand?: string, hasRetentionPolicy?: string, limit?: string, spaceKeys?: string, contentLabel?: string, spaceIds?: string, status?: string, requestBody?: string): CancelablePromise<{ results?: Array; totalCount?: number; start?: number; limit?: number; size?: number; _links?: { base?: string; context?: string; self?: string; next?: string; prev?: string; }; }>; /** * Creates a new Space. * Creates a new Space. The incoming Space does not include an id, but must include a Key and Name, and should include a Description. * @param requestBody The space to be created * @returns Space Returns a full JSON representation of a space. * @throws ApiError */ static createSpace(requestBody: Space): CancelablePromise; /** * Get space * Returns information about a space. * * Example request URI: * * `http://example.com/confluence/rest/api/space/TST?expand=description` * @param spaceKey the key of the space to update. * @param expand a comma separated list of properties to expand on the space. * @returns Space Returns a full JSON representation of a space. * @throws ApiError */ static space(spaceKey: string, expand?: string): CancelablePromise; /** * Update Space * Updates a Space. The incoming Space must include a Key and Name, and should include a Description * @param spaceKey the key of the space to update. * @param requestBody the space being updated * @returns Space Returns a full JSON representation of a space. * @throws ApiError */ static update4(spaceKey: string, requestBody: Space): CancelablePromise; /** * Delete Space * Deletes a Space. The space is deleted in a long running task, so the space cannot be considered deleted when this resource returns. Clients can follow the status link in the response and poll it until the task completes. * @param spaceKey the key of the space to update. * @returns LongTaskSubmission Returns a pointer to the status of the space-deletion task. * @throws ApiError */ static delete5(spaceKey: string): CancelablePromise; /** * Restore space * Restore the given Space identified by spaceKey. This method is idempotent i.e., if the Space is already restored then no action will be taken. * @param spaceKey the key of the space to update. * @returns void * @throws ApiError */ static restore(spaceKey: string): CancelablePromise; } //# sourceMappingURL=SpaceService.d.ts.map