@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,844 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type ContentProperty, type MultiEntityLinks } from "../models/common";
+import type { ContentPropertyCreateRequest, ContentPropertySortOrder, ContentPropertyUpdateRequest } from "../models/contentProperties";
+export declare class ContentPropertiesService extends CommonHttpService {
+    /**
+     * Creates a new content property for an attachment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the attachment.
+     *
+     * @returns Returned if the content property was created successfully.
+     * @path {POST} /attachments/{attachment-id}/properties
+     * @scopes-current read:attachment:confluence, write:attachment:confluence
+     */
+    createAttachmentProperty({ attachmentId, contentPropertyCreateRequest, }: {
+        /** The ID of the attachment to create a property for. */
+        attachmentId: string;
+        /** The content property to be created */
+        contentPropertyCreateRequest: ContentPropertyCreateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Creates a new property for a blogpost.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the blog post.
+     *
+     * @returns Returned if the content property was created successfully.
+     * @path {POST} /blogposts/{blogpost-id}/properties
+     * @scopes-current read:page:confluence, write:page:confluence
+     */
+    createBlogpostProperty({ blogpostId, contentPropertyCreateRequest, }: {
+        /** The ID of the blog post to create a property for. */
+        blogpostId: number;
+        /** The content property to be created */
+        contentPropertyCreateRequest: ContentPropertyCreateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Creates a new content property for a comment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the comment.
+     *
+     * @returns Returned if the content property was created successfully.
+     * @path {POST} /comments/{comment-id}/properties
+     * @scopes-current read:comment:confluence, write:comment:confluence
+     */
+    createCommentProperty({ commentId, contentPropertyCreateRequest, }: {
+        /** The ID of the comment to create a property for. */
+        commentId: number;
+        /** The content property to be created */
+        contentPropertyCreateRequest: ContentPropertyCreateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Creates a new content property for a piece of custom content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the custom content.
+     *
+     * @returns Returned if the content property was created successfully.
+     * @path {POST} /custom-content/{custom-content-id}/properties
+     * @scopes-current read:custom-content:confluence, write:custom-content:confluence
+     */
+    createCustomContentProperty({ customContentId, contentPropertyCreateRequest, }: {
+        /** The ID of the custom content to create a property for. */
+        customContentId: number;
+        /** The content property to be created */
+        contentPropertyCreateRequest: ContentPropertyCreateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Creates a new content property for a database.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the database.
+     *
+     * @returns Returned if the content property was created successfully.
+     * @path {POST} /databases/{id}/properties
+     * @scopes-current read:database:confluence, write:database:confluence
+     */
+    createDatabaseProperty({ id, contentPropertyCreateRequest, }: {
+        /** The ID of the database to create a property for. */
+        id: number;
+        /** The content property to be created */
+        contentPropertyCreateRequest: ContentPropertyCreateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Creates a new content property for a page.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the page.
+     *
+     * @returns Returned if the content property was created successfully.
+     * @path {POST} /pages/{page-id}/properties
+     * @scopes-current read:page:confluence, write:page:confluence
+     */
+    createPageProperty({ pageId, contentPropertyCreateRequest, }: {
+        /** The ID of the page to create a property for. */
+        pageId: number;
+        /** The content property to be created */
+        contentPropertyCreateRequest: ContentPropertyCreateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Creates a new content property for a Smart Link in the content tree.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the Smart Link in the content tree.
+     *
+     * @returns Returned if the content property was created successfully.
+     * @path {POST} /embeds/{id}/properties
+     * @scopes-current read:embed:confluence, write:embed:confluence
+     */
+    createSmartLinkProperty({ id, contentPropertyCreateRequest, }: {
+        /** The ID of the Smart Link in the content tree to create a property for. */
+        id: number;
+        /** The content property to be created */
+        contentPropertyCreateRequest: ContentPropertyCreateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Creates a new content property for a whiteboard.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to update the whiteboard.
+     *
+     * @returns Returned if the content property was created successfully.
+     * @path {POST} /whiteboards/{id}/properties
+     * @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
+     */
+    createWhiteboardProperty({ id, contentPropertyCreateRequest, }: {
+        /** The ID of the whiteboard to create a property for. */
+        id: number;
+        /** The content property to be created */
+        contentPropertyCreateRequest: ContentPropertyCreateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Deletes a content property for an attachment by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to attachment the page.
+     *
+     * @path {DELETE} /attachments/{attachment-id}/properties/{property-id}
+     * @scopes-current read:attachment:confluence, write:attachment:confluence
+     */
+    deleteAttachmentPropertyById({ attachmentId, propertyId, }: {
+        /** The ID of the attachment the property belongs to. */
+        attachmentId: string;
+        /** The ID of the property to be deleted. */
+        propertyId: number;
+    }): Promise<void>;
+    /**
+     * Deletes a content property for a blogpost by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the blog post.
+     *
+     * @path {DELETE} /blogposts/{blogpost-id}/properties/{property-id}
+     * @scopes-current read:page:confluence, write:page:confluence
+     */
+    deleteBlogpostPropertyById({ blogpostId, propertyId, }: {
+        /** The ID of the blog post the property belongs to. */
+        blogpostId: number;
+        /** The ID of the property to be deleted. */
+        propertyId: number;
+    }): Promise<void>;
+    /**
+     * Deletes a content property for a comment by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the comment.
+     *
+     * @path {DELETE} /comments/{comment-id}/properties/{property-id}
+     * @scopes-current read:comment:confluence, write:comment:confluence
+     */
+    deleteCommentPropertyById({ commentId, propertyId, }: {
+        /** The ID of the comment the property belongs to. */
+        commentId: number;
+        /** The ID of the property to be deleted. */
+        propertyId: number;
+    }): Promise<void>;
+    /**
+     * Deletes a content property for a piece of custom content by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the custom content.
+     *
+     * @path {DELETE} /custom-content/{custom-content-id}/properties/{property-id}
+     * @scopes-current read:custom-content:confluence, write:custom-content:confluence
+     */
+    deleteCustomContentPropertyById({ customContentId, propertyId, }: {
+        /** The ID of the custom content the property belongs to. */
+        customContentId: number;
+        /** The ID of the property to be deleted. */
+        propertyId: number;
+    }): Promise<void>;
+    /**
+     * Deletes a content property for a database by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the database.
+     *
+     * @path {DELETE} /databases/{database-id}/properties/{property-id}
+     * @scopes-current read:database:confluence, write:database:confluence
+     */
+    deleteDatabasePropertyById({ databaseId, propertyId, }: {
+        /** The ID of the database the property belongs to. */
+        databaseId: number;
+        /** The ID of the property to be deleted. */
+        propertyId: number;
+    }): Promise<void>;
+    /**
+     * Deletes a content property for a page by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the page.
+     *
+     * @path {DELETE} /pages/{page-id}/properties/{property-id}
+     * @scopes-current read:page:confluence, write:page:confluence
+     */
+    deletePagePropertyById({ pageId, propertyId, }: {
+        /** The ID of the page the property belongs to. */
+        pageId: number;
+        /** The ID of the property to be deleted. */
+        propertyId: number;
+    }): Promise<void>;
+    /**
+     * Deletes a content property for a Smart Link in the content tree by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the Smart Link in the content tree.
+     *
+     * @path {DELETE} /embeds/{embed-id}/properties/{property-id}
+     * @scopes-current read:embed:confluence, write:embed:confluence
+     */
+    deleteSmartLinkPropertyById({ embedId, propertyId, }: {
+        /** The ID of the Smart Link in the content tree the property belongs to. */
+        embedId: number;
+        /** The ID of the property to be deleted. */
+        propertyId: number;
+    }): Promise<void>;
+    /**
+     * Deletes a content property for a whiteboard by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the whiteboard.
+     *
+     * @path {DELETE} /whiteboards/{whiteboard-id}/properties/{property-id}
+     * @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
+     */
+    deleteWhiteboardPropertyById({ whiteboardId, propertyId, }: {
+        /** The ID of the whiteboard the property belongs to. */
+        whiteboardId: number;
+        /** The ID of the property to be deleted. */
+        propertyId: number;
+    }): Promise<void>;
+    /**
+     * Retrieves all Content Properties tied to a specified attachment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment.
+     *
+     * @returns Returned if the requested content properties are successfully retrieved.
+     * @path {GET} /attachments/{attachment-id}/properties
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachmentContentProperties({ attachmentId, key, sort, cursor, limit, }: {
+        /** The ID of the attachment for which content properties should be returned. */
+        attachmentId: string;
+        /**
+         * Filters the response to return a specific content property with matching key
+         * (case sensitive).
+         */
+        key?: string;
+        /** Used to sort the result by a particular field. */
+        sort?: ContentPropertySortOrder;
+        /**
+         * 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 attachments 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;
+    }): Promise<{
+        results?: ContentProperty[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves a specific Content Property by ID that is attached to a specified
+     * attachment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the attachment.
+     *
+     * @returns Returned if the requested content property is successfully retrieved.
+     * @path {GET} /attachments/{attachment-id}/properties/{property-id}
+     * @scopes-current read:attachment:confluence
+     */
+    getAttachmentContentPropertiesById({ attachmentId, propertyId, }: {
+        /** The ID of the attachment for which content properties should be returned. */
+        attachmentId: string;
+        /** The ID of the content property to be returned */
+        propertyId: number;
+    }): Promise<ContentProperty>;
+    /**
+     * Retrieves all Content Properties tied to a specified blog post.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the blog post.
+     *
+     * @returns Returned if the requested content properties are successfully retrieved.
+     * @path {GET} /blogposts/{blogpost-id}/properties
+     * @scopes-current read:page:confluence
+     */
+    getBlogpostContentProperties({ blogpostId, key, sort, cursor, limit, }: {
+        /** The ID of the blog post for which content properties should be returned. */
+        blogpostId: number;
+        /**
+         * Filters the response to return a specific content property with matching key
+         * (case sensitive).
+         */
+        key?: string;
+        /** Used to sort the result by a particular field. */
+        sort?: ContentPropertySortOrder;
+        /**
+         * 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 attachments 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;
+    }): Promise<{
+        results?: ContentProperty[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves a specific Content Property by ID that is attached to a specified
+     * blog post.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the blog post.
+     *
+     * @returns Returned if the requested content property is successfully retrieved.
+     * @path {GET} /blogposts/{blogpost-id}/properties/{property-id}
+     * @scopes-current read:page:confluence
+     */
+    getBlogpostContentPropertiesById({ blogpostId, propertyId, }: {
+        /** The ID of the blog post for which content properties should be returned. */
+        blogpostId: number;
+        /** The ID of the property being requested */
+        propertyId: number;
+    }): Promise<ContentProperty>;
+    /**
+     * Retrieves Content Properties attached to a specified comment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the comment.
+     *
+     * @returns Returned if the requested content properties are successfully retrieved.
+     * @path {GET} /comments/{comment-id}/properties
+     * @scopes-current read:comment:confluence
+     */
+    getCommentContentProperties({ commentId, key, sort, cursor, limit, }: {
+        /** The ID of the comment for which content properties should be returned. */
+        commentId: number;
+        /**
+         * Filters the response to return a specific content property with matching key
+         * (case sensitive).
+         */
+        key?: string;
+        /** Used to sort the result by a particular field. */
+        sort?: ContentPropertySortOrder;
+        /**
+         * 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 attachments 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;
+    }): Promise<{
+        results?: ContentProperty[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves a specific Content Property by ID that is attached to a specified
+     * comment.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the comment.
+     *
+     * @returns Returned if the requested content property is successfully retrieved.
+     * @path {GET} /comments/{comment-id}/properties/{property-id}
+     * @scopes-current read:comment:confluence
+     */
+    getCommentContentPropertiesById({ commentId, propertyId, }: {
+        /** The ID of the comment for which content properties should be returned. */
+        commentId: number;
+        /** The ID of the content property being requested. */
+        propertyId: number;
+    }): Promise<ContentProperty>;
+    /**
+     * Retrieves Content Properties tied to a specified custom content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the custom content.
+     *
+     * @returns Returned if the requested content properties are successfully retrieved.
+     * @path {GET} /custom-content/{custom-content-id}/properties
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentContentProperties({ customContentId, key, sort, cursor, limit, }: {
+        /** The ID of the custom content for which content properties should be returned. */
+        customContentId: number;
+        /**
+         * Filters the response to return a specific content property with matching key
+         * (case sensitive).
+         */
+        key?: string;
+        /** Used to sort the result by a particular field. */
+        sort?: ContentPropertySortOrder;
+        /**
+         * 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 attachments 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;
+    }): Promise<{
+        results?: ContentProperty[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves a specific Content Property by ID that is attached to a specified
+     * custom content.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page.
+     *
+     * @returns Returned if the requested content property is successfully retrieved.
+     * @path {GET} /custom-content/{custom-content-id}/properties/{property-id}
+     * @scopes-current read:custom-content:confluence
+     */
+    getCustomContentContentPropertiesById({ customContentId, propertyId, }: {
+        /** The ID of the custom content for which content properties should be returned. */
+        customContentId: number;
+        /** The ID of the content property being requested. */
+        propertyId: number;
+    }): Promise<ContentProperty>;
+    /**
+     * Retrieves Content Properties tied to a specified database.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the database.
+     *
+     * @returns Returned if the requested content properties are successfully retrieved.
+     * @path {GET} /databases/{id}/properties
+     * @scopes-current read:database:confluence
+     */
+    getDatabaseContentProperties({ id, key, sort, cursor, limit, }: {
+        /** The ID of the database for which content properties should be returned. */
+        id: number;
+        /**
+         * Filters the response to return a specific content property with matching key
+         * (case sensitive).
+         */
+        key?: string;
+        /** Used to sort the result by a particular field. */
+        sort?: ContentPropertySortOrder;
+        /**
+         * 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 attachments 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;
+    }): Promise<{
+        results?: ContentProperty[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves a specific Content Property by ID that is attached to a specified
+     * database.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the database.
+     *
+     * @returns Returned if the requested content property is successfully retrieved.
+     * @path {GET} /databases/{database-id}/properties/{property-id}
+     * @scopes-current read:database:confluence
+     */
+    getDatabaseContentPropertiesById({ databaseId, propertyId, }: {
+        /** The ID of the database for which content properties should be returned. */
+        databaseId: number;
+        /** The ID of the content property being requested. */
+        propertyId: number;
+    }): Promise<ContentProperty>;
+    /**
+     * Retrieves Content Properties tied to a specified page.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page.
+     *
+     * @returns Returned if the requested content properties are successfully retrieved.
+     * @path {GET} /pages/{page-id}/properties
+     * @scopes-current read:page:confluence
+     */
+    getPageContentProperties({ pageId, key, sort, cursor, limit, }: {
+        /** The ID of the page for which content properties should be returned. */
+        pageId: number;
+        /**
+         * Filters the response to return a specific content property with matching key
+         * (case sensitive).
+         */
+        key?: string;
+        /** Used to sort the result by a particular field. */
+        sort?: ContentPropertySortOrder;
+        /**
+         * 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 attachments 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;
+    }): Promise<{
+        results?: ContentProperty[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves a specific Content Property by ID that is attached to a specified
+     * page.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the page.
+     *
+     * @returns Returned if the requested content property is successfully retrieved.
+     * @path {GET} /pages/{page-id}/properties/{property-id}
+     * @scopes-current read:page:confluence
+     */
+    getPageContentPropertiesById({ pageId, propertyId, }: {
+        /** The ID of the page for which content properties should be returned. */
+        pageId: number;
+        /** The ID of the content property being requested. */
+        propertyId: number;
+    }): Promise<ContentProperty>;
+    /**
+     * Retrieves Content Properties tied to a specified Smart Link in the content tree.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the Smart Link in the content tree.
+     *
+     * @returns Returned if the requested content properties are successfully retrieved.
+     * @path {GET} /embeds/{id}/properties
+     * @scopes-current read:embed:confluence
+     */
+    getSmartLinkContentProperties({ id, key, sort, cursor, limit, }: {
+        /**
+         * The ID of the Smart Link in the content tree for which content properties
+         * should be returned.
+         */
+        id: number;
+        /**
+         * Filters the response to return a specific content property with matching key
+         * (case sensitive).
+         */
+        key?: string;
+        /** Used to sort the result by a particular field. */
+        sort?: ContentPropertySortOrder;
+        /**
+         * 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 attachments 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;
+    }): Promise<{
+        results?: ContentProperty[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves a specific Content Property by ID that is attached to a specified
+     * Smart Link in the content tree.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the Smart Link in the content tree.
+     *
+     * @returns Returned if the requested content property is successfully retrieved.
+     * @path {GET} /embeds/{embed-id}/properties/{property-id}
+     * @scopes-current read:embed:confluence
+     */
+    getSmartLinkContentPropertiesById({ embedId, propertyId, }: {
+        /**
+         * The ID of the Smart Link in the content tree for which content properties
+         * should be returned.
+         */
+        embedId: number;
+        /** The ID of the content property being requested. */
+        propertyId: number;
+    }): Promise<ContentProperty>;
+    /**
+     * Retrieves Content Properties tied to a specified whiteboard.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the whiteboard.
+     *
+     * @returns Returned if the requested content properties are successfully retrieved.
+     * @path {GET} /whiteboards/{id}/properties
+     * @scopes-current read:whiteboard:confluence
+     */
+    getWhiteboardContentProperties({ id, key, sort, cursor, limit, }: {
+        /** The ID of the whiteboard for which content properties should be returned. */
+        id: number;
+        /**
+         * Filters the response to return a specific content property with matching key
+         * (case sensitive).
+         */
+        key?: string;
+        /** Used to sort the result by a particular field. */
+        sort?: ContentPropertySortOrder;
+        /**
+         * 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 attachments 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;
+    }): Promise<{
+        results?: ContentProperty[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Retrieves a specific Content Property by ID that is attached to a specified
+     * whiteboard.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to view the whiteboard.
+     *
+     * @returns Returned if the requested content property is successfully retrieved.
+     * @path {GET} /whiteboards/{whiteboard-id}/properties/{property-id}
+     * @scopes-current read:whiteboard:confluence
+     */
+    getWhiteboardContentPropertiesById({ whiteboardId, propertyId, }: {
+        /** The ID of the whiteboard for which content properties should be returned. */
+        whiteboardId: number;
+        /** The ID of the content property being requested. */
+        propertyId: number;
+    }): Promise<ContentProperty>;
+    /**
+     * Update a content property for attachment by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the attachment.
+     *
+     * @returns Returned if the content property was updated successfully.
+     * @path {PUT} /attachments/{attachment-id}/properties/{property-id}
+     * @scopes-current read:attachment:confluence, write:attachment:confluence
+     */
+    updateAttachmentPropertyById({ attachmentId, propertyId, contentPropertyUpdateRequest, }: {
+        /** The ID of the attachment the property belongs to. */
+        attachmentId: string;
+        /** The ID of the property to be updated. */
+        propertyId: number;
+        /** The content property to be updated. */
+        contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Update a content property for blog post by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the blog post.
+     *
+     * @returns Returned if the content property was updated successfully.
+     * @path {PUT} /blogposts/{blogpost-id}/properties/{property-id}
+     * @scopes-current read:page:confluence, write:page:confluence
+     */
+    updateBlogpostPropertyById({ blogpostId, propertyId, contentPropertyUpdateRequest, }: {
+        /** The ID of the blog post the property belongs to. */
+        blogpostId: number;
+        /** The ID of the property to be updated. */
+        propertyId: number;
+        /** The content property to be updated. */
+        contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Update a content property for a comment by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the comment.
+     *
+     * @returns Returned if the content property was updated successfully.
+     * @path {PUT} /comments/{comment-id}/properties/{property-id}
+     * @scopes-current read:comment:confluence, write:comment:confluence
+     */
+    updateCommentPropertyById({ commentId, propertyId, contentPropertyUpdateRequest, }: {
+        /** The ID of the comment the property belongs to. */
+        commentId: number;
+        /** The ID of the property to be updated. */
+        propertyId: number;
+        /** The content property to be updated. */
+        contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Update a content property for a piece of custom content by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the custom content.
+     *
+     * @returns Returned if the content property was updated successfully.
+     * @path {PUT} /custom-content/{custom-content-id}/properties/{property-id}
+     * @scopes-current read:custom-content:confluence, write:custom-content:confluence
+     */
+    updateCustomContentPropertyById({ customContentId, propertyId, contentPropertyUpdateRequest, }: {
+        /** The ID of the custom content the property belongs to. */
+        customContentId: number;
+        /** The ID of the property to be updated. */
+        propertyId: number;
+        /** The content property to be updated. */
+        contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Update a content property for a database by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the database.
+     *
+     * @returns Returned if the content property was updated successfully.
+     * @path {PUT} /databases/{database-id}/properties/{property-id}
+     * @scopes-current read:database:confluence, write:database:confluence
+     */
+    updateDatabasePropertyById({ databaseId, propertyId, contentPropertyUpdateRequest, }: {
+        /** The ID of the database the property belongs to. */
+        databaseId: number;
+        /** The ID of the property to be updated. */
+        propertyId: number;
+        /** The content property to be updated. */
+        contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Update a content property for a page by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the page.
+     *
+     * @returns Returned if the content property was updated successfully.
+     * @path {PUT} /pages/{page-id}/properties/{property-id}
+     * @scopes-current read:page:confluence, write:page:confluence
+     */
+    updatePagePropertyById({ pageId, propertyId, contentPropertyUpdateRequest, }: {
+        /** The ID of the page the property belongs to. */
+        pageId: number;
+        /** The ID of the property to be updated. */
+        propertyId: number;
+        /** The content property to be updated. */
+        contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Update a content property for a Smart Link in the content tree by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the Smart Link in the content tree.
+     *
+     * @returns Returned if the content property was updated successfully.
+     * @path {PUT} /embeds/{embed-id}/properties/{property-id}
+     * @scopes-current read:embed:confluence, write:embed:confluence
+     */
+    updateSmartLinkPropertyById({ embedId, propertyId, contentPropertyUpdateRequest, }: {
+        /** The ID of the Smart Link in the content tree the property belongs to. */
+        embedId: number;
+        /** The ID of the property to be updated. */
+        propertyId: number;
+        /** The content property to be updated. */
+        contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
+    }): Promise<ContentProperty>;
+    /**
+     * Update a content property for a whiteboard by its id.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to edit the whiteboard.
+     *
+     * @returns Returned if the content property was updated successfully.
+     * @path {PUT} /whiteboards/{whiteboard-id}/properties/{property-id}
+     * @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
+     */
+    updateWhiteboardPropertyById({ whiteboardId, propertyId, contentPropertyUpdateRequest, }: {
+        /** The ID of the whiteboard the property belongs to. */
+        whiteboardId: number;
+        /** The ID of the property to be updated. */
+        propertyId: number;
+        /** The content property to be updated. */
+        contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
+    }): Promise<ContentProperty>;
+    static initialize(): void;
+}