@resolution/confluence-api-client 0.2.0

package/lib/openapi/v2/services/VersionService.d.ts

@@ -0,0 +1,350 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type CustomContentBodyRepresentation, type MultiEntityLinks, type PrimaryBodyRepresentation } from "../models/common";
+import { type AttachmentVersion, type BlogPostVersion, type CommentVersion, type CustomContentVersion, type DetailedVersion, type PageVersion, type VersionSortOrder } from "../models/version";
+export declare class VersionService extends CommonHttpService {
+    /**
+     * Retrieves version details for the specified attachment and version number.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /attachments/{attachment-id}/versions/{version-number}
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachmentVersionDetails({ attachmentId, versionNumber, }: {
+        /** The ID of the attachment for which version details should be returned. */
+        attachmentId: string;
+        /** The version number of the attachment to be returned. */
+        versionNumber: number;
+    }): Promise<DetailedVersion>;
+    /**
+     * Returns the versions of specific attachment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment and its corresponding space.
+     *
+     * @returns Returned if the requested attachment versions are returned.
+     * @path {GET} /attachments/{id}/versions
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachmentVersions({ id, cursor, limit, sort, }: {
+        /**
+         * The ID of the attachment to be queried for its versions. If you don't know the
+         * attachment ID, use Get attachments and filter the results.
+         */
+        id: string;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of versions per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+        /** Used to sort the result by a particular field. */
+        sort?: VersionSortOrder;
+    }): Promise<{
+        results?: AttachmentVersion[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves version details for the specified blog post and version number.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the blog post.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /blogposts/{blogpost-id}/versions/{version-number}
+     * @scopes-current read:page:confluence
+     */
+    getBlogPostVersionDetails({ blogpostId, versionNumber, }: {
+        /** The ID of the blog post for which version details should be returned. */
+        blogpostId: number;
+        /** The version number of the blog post to be returned. */
+        versionNumber: number;
+    }): Promise<DetailedVersion>;
+    /**
+     * Returns the versions of specific blog post.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the blog post and its corresponding space.
+     *
+     * @returns Returned if the requested blog post versions are returned.
+     * @path {GET} /blogposts/{id}/versions
+     * @scopes-current read:page:confluence
+     */
+    getBlogPostVersions({ id, bodyFormat, cursor, limit, sort, }: {
+        /**
+         * The ID of the blog post to be queried for its versions. If you don't know the
+         * blog post ID, use Get blog posts and filter the results.
+         */
+        id: number;
+        /**
+         * The content format types to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of versions per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+        /** Used to sort the result by a particular field. */
+        sort?: VersionSortOrder;
+    }): Promise<{
+        results?: BlogPostVersion[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves version details for the specified custom content and version number.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /custom-content/{custom-content-id}/versions/{version-number}
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentVersionDetails({ customContentId, versionNumber, }: {
+        /** The ID of the custom content for which version details should be returned. */
+        customContentId: number;
+        /** The version number of the custom content to be returned. */
+        versionNumber: number;
+    }): Promise<DetailedVersion>;
+    /**
+     * Returns the versions of specific custom content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the custom content and its corresponding page and space.
+     *
+     * @returns Returned if the requested custom content versions are returned.
+     * @path {GET} /custom-content/{custom-content-id}/versions
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentVersions({ customContentId, bodyFormat, cursor, limit, sort, }: {
+        /**
+         * The ID of the custom content to be queried for its versions. If you don't know
+         * the custom content ID, use Get custom-content by type and filter the results.
+         */
+        customContentId: number;
+        /**
+         * The content format types to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         *
+         * Note: If the custom content body type is `storage`, the `storage` and
+         * `atlas_doc_format` body formats are able to be returned. If the custom content
+         * body type is `raw`, only the `raw` body format is able to be returned.
+         */
+        bodyFormat?: CustomContentBodyRepresentation;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of versions per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+        /** Used to sort the result by a particular field. */
+        sort?: VersionSortOrder;
+    }): Promise<{
+        results?: CustomContentVersion[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves version details for the specified footer comment version.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blog post and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /footer-comments/{id}/versions/{version-number}
+     * @scopes-current read:comment:confluence
+     */
+    getFooterCommentVersionDetails({ id, versionNumber, }: {
+        /** The ID of the footer comment for which version details should be returned. */
+        id: number;
+        /** The version number of the footer comment to be returned. */
+        versionNumber: number;
+    }): Promise<DetailedVersion>;
+    /**
+     * Retrieves the versions of the specified footer comment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blog post and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested footer comment versions are returned.
+     * @path {GET} /footer-comments/{id}/versions
+     * @scopes-current read:comment:confluence
+     */
+    getFooterCommentVersions({ id, bodyFormat, cursor, limit, sort, }: {
+        /** The ID of the footer comment for which versions should be returned */
+        id: number;
+        /**
+         * The content format types to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of versions per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+        /** Used to sort the result by a particular field. */
+        sort?: VersionSortOrder;
+    }): Promise<{
+        results?: CommentVersion[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves version details for the specified inline comment version.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blog post and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /inline-comments/{id}/versions/{version-number}
+     * @scopes-current read:comment:confluence
+     */
+    getInlineCommentVersionDetails({ id, versionNumber, }: {
+        /** The ID of the inline comment for which version details should be returned. */
+        id: number;
+        /** The version number of the inline comment to be returned. */
+        versionNumber: number;
+    }): Promise<DetailedVersion>;
+    /**
+     * Retrieves the versions of the specified inline comment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the content of the page or blog post and its corresponding
+     * space.
+     *
+     * @returns Returned if the requested inline comment versions are returned.
+     * @path {GET} /inline-comments/{id}/versions
+     * @scopes-current read:comment:confluence
+     */
+    getInlineCommentVersions({ id, bodyFormat, cursor, limit, sort, }: {
+        /** The ID of the inline comment for which versions should be returned */
+        id: number;
+        /**
+         * The content format types to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of versions per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+        /** Used to sort the result by a particular field. */
+        sort?: VersionSortOrder;
+    }): Promise<{
+        results?: CommentVersion[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves version details for the specified page and version number.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page.
+     *
+     * @returns Returned if the requested version details are successfully retrieved.
+     * @path {GET} /pages/{page-id}/versions/{version-number}
+     * @scopes-current read:page:confluence
+     */
+    getPageVersionDetails({ pageId, versionNumber, }: {
+        /** The ID of the page for which version details should be returned. */
+        pageId: number;
+        /** The version number of the page to be returned. */
+        versionNumber: number;
+    }): Promise<DetailedVersion>;
+    /**
+     * Returns the versions of specific page.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page and its corresponding space.
+     *
+     * @returns Returned if the requested page versions are returned.
+     * @path {GET} /pages/{id}/versions
+     * @scopes-current read:page:confluence
+     */
+    getPageVersions({ id, bodyFormat, cursor, limit, sort, }: {
+        /**
+         * The ID of the page to be queried for its versions. If you don't know the page
+         * ID, use Get pages and filter the results.
+         */
+        id: number;
+        /**
+         * The content format types to be returned in the `body` field of the response. If
+         * available, the representation will be available under a response field of the
+         * same name under the `body` field.
+         */
+        bodyFormat?: PrimaryBodyRepresentation;
+        /**
+         * Used for pagination, this opaque cursor will be returned in the `next` URL in
+         * the `Link` response header. Use the relative URL in the `Link` header to
+         * retrieve the `next` set of results.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of versions per result to return. If more results exist, use the
+         * `Link` header to retrieve a relative URL that will return the next set of
+         * results.
+         */
+        limit?: number;
+        /** Used to sort the result by a particular field. */
+        sort?: VersionSortOrder;
+    }): Promise<{
+        results?: PageVersion[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    static initialize(): void;
+}