@resolution/confluence-api-client 0.2.0

package/lib/openapi/v2/models/classificationLevel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"classificationLevel.js","sourceRoot":"","sources":["../../../../src/openapi/v2/models/classificationLevel.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAuCzC,SAAgB,4CAA4C,CAC1D,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,qBAAqB,EACrB,OAAC;SACE,MAAM,CAAC;QACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACzB,MAAM,EAAE,uBAAuB;aAC5B,IAAI,CAAC,2BAA2B,CAAC;aACjC,QAAQ,EAAE;QACb,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,KAAK,EAAE,uBAAuB;aAC3B,IAAI,CAAC,0BAA0B,CAAC;aAChC,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,qBAAqB,CAAC,CACnC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,0BAA0B,EAC1B,OAAC;SACE,IAAI,CAAC;QACJ,KAAK;QACL,UAAU;QACV,QAAQ;QACR,QAAQ;QACR,OAAO;QACP,MAAM;QACN,MAAM;QACN,MAAM;QACN,QAAQ;QACR,MAAM;QACN,MAAM;KACP,CAAC;SACD,QAAQ,CAAC,0BAA0B,CAAC,CACxC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,2BAA2B,EAC3B,OAAC;SACE,IAAI,CAAC,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;SACxC,QAAQ,CAAC,2BAA2B,CAAC,CACzC,CAAC;AACJ,CAAC;AA9CD,oGA8CC"}

package/lib/openapi/v2/models/comment.d.ts

@@ -0,0 +1,396 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+import { type BodyBulk, type BodySingle, type ContentProperty, type ContentStatus, type Like, type Operation, type OptionalFieldLinks, type OptionalFieldMeta, type Version } from "./common";
+export interface AttachmentCommentModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the attachment containing the comment. */
+    attachmentId?: string;
+    version?: Version;
+    /** Contains fields for each representation type requested. */
+    body?: BodySingle;
+    _links?: CommentLinks;
+}
+export interface BlogPostCommentModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the blog post the comment is in. */
+    blogPostId?: string;
+    version?: Version;
+    /** Contains fields for each representation type requested. */
+    body?: BodyBulk;
+    _links?: CommentLinks;
+}
+export interface BlogPostInlineCommentModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the blog post the comment is in. */
+    blogPostId?: string;
+    version?: Version;
+    /** Contains fields for each representation type requested. */
+    body?: BodyBulk;
+    /** Inline comment resolution status */
+    resolutionStatus?: InlineCommentResolutionStatus;
+    properties?: InlineCommentProperties;
+    _links?: CommentLinks;
+}
+export interface ChildrenCommentModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the parent comment the child comment is in. */
+    parentCommentId?: string;
+    version?: Version;
+    /** Contains fields for each representation type requested. */
+    body?: BodyBulk;
+    _links?: CommentLinks;
+}
+export interface CommentBodyWrite extends Record<string, unknown> {
+    /** Type of content representation used for the value field. */
+    representation?: "storage" | "atlas_doc_format" | "wiki";
+    /** Body of the comment, in the format found in the representation field. */
+    value?: string;
+}
+export interface CommentLinks extends Record<string, unknown> {
+    /** Web UI link of the content. */
+    webui?: string;
+}
+/**
+ * Body of the comment. Only one body format should be specified as the property
+ * for this object, e.g. `storage`.
+ */
+export interface CommentNestedBodyWrite extends Record<string, unknown> {
+    storage?: CommentBodyWrite;
+    atlas_doc_format?: CommentBodyWrite;
+    wiki?: CommentBodyWrite;
+}
+/**
+ * The sort fields for comments. The default sort direction is ascending. To sort
+ * in descending order, append a `-` character before the sort field. For example,
+ * `fieldName` or `-fieldName`.
+ */
+export type CommentSortOrder = "created-date" | "-created-date" | "modified-date" | "-modified-date";
+export interface CreateFooterCommentModel extends Record<string, unknown> {
+    /**
+     * ID of the containing blog post, if intending to create a top level footer
+     * comment. Do not provide if creating a reply.
+     */
+    blogPostId?: string;
+    /**
+     * ID of the containing page, if intending to create a top level footer comment.
+     * Do not provide if creating a reply.
+     */
+    pageId?: string;
+    /**
+     * ID of the parent comment, if intending to create a reply. Do not provide if
+     * creating a top level comment.
+     */
+    parentCommentId?: string;
+    /** ID of the attachment, if intending to create a comment against an attachment. */
+    attachmentId?: string;
+    /**
+     * ID of the custom content, if intending to create a comment against a custom
+     * content.
+     */
+    customContentId?: string;
+    body?: CommentBodyWrite | CommentNestedBodyWrite;
+}
+export interface CreateInlineCommentModel extends Record<string, unknown> {
+    /**
+     * ID of the containing blog post, if intending to create a top level footer
+     * comment. Do not provide if creating a reply.
+     */
+    blogPostId?: string;
+    /**
+     * ID of the containing page, if intending to create a top level footer comment.
+     * Do not provide if creating a reply.
+     */
+    pageId?: string;
+    /**
+     * ID of the parent comment, if intending to create a reply. Do not provide if
+     * creating a top level comment.
+     */
+    parentCommentId?: string;
+    body?: CommentBodyWrite | CommentNestedBodyWrite;
+    /**
+     * Object describing the text to highlight on the page/blog post. Only applicable
+     * for top level inline comments (not replies) and required in that case.
+     */
+    inlineCommentProperties?: {
+        /** The text to highlight */
+        textSelection?: string;
+        /**
+         * The number of matches for the selected text on the page (should be strictly
+         * greater than textSelectionMatchIndex)
+         */
+        textSelectionMatchCount?: number;
+        /**
+         * The match index to highlight. This is zero-based. E.g. if you have 3
+         * occurrences of "hello world" on a page
+         * and you want to highlight the second occurrence, you should pass 1 for
+         * textSelectionMatchIndex and 3 for textSelectionMatchCount.
+         */
+        textSelectionMatchIndex?: number;
+    } & {
+        [key: string]: unknown;
+    };
+}
+export interface CustomContentCommentModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the custom content containing the comment. */
+    customContentId?: string;
+    version?: Version;
+    /** Contains fields for each representation type requested. */
+    body?: BodySingle;
+    _links?: CommentLinks;
+}
+export interface FooterCommentModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the blog post containing the comment if the comment is on a blog post. */
+    blogPostId?: string;
+    /** ID of the page containing the comment if the comment is on a page. */
+    pageId?: string;
+    /** ID of the attachment containing the comment if the comment is on an attachment. */
+    attachmentId?: string;
+    /**
+     * ID of the custom content containing the comment if the comment is on a custom
+     * content.
+     */
+    customContentId?: string;
+    /** ID of the parent comment if the comment is a reply. */
+    parentCommentId?: string;
+    version?: Version;
+    properties?: {
+        results?: ContentProperty[];
+        meta?: OptionalFieldMeta;
+        _links?: OptionalFieldLinks;
+    } & {
+        [key: string]: unknown;
+    };
+    operations?: {
+        results?: Operation[];
+        meta?: OptionalFieldMeta;
+        _links?: OptionalFieldLinks;
+    } & {
+        [key: string]: unknown;
+    };
+    likes?: {
+        results?: Like[];
+        meta?: OptionalFieldMeta;
+        _links?: OptionalFieldLinks;
+    } & {
+        [key: string]: unknown;
+    };
+    versions?: {
+        results?: Version[];
+        meta?: OptionalFieldMeta;
+        _links?: OptionalFieldLinks;
+    } & {
+        [key: string]: unknown;
+    };
+    /** Contains fields for each representation type requested. */
+    body?: BodySingle;
+    _links?: CommentLinks;
+}
+export interface InlineCommentChildrenModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the parent comment the child comment is in. */
+    parentCommentId?: string;
+    version?: Version;
+    /** Contains fields for each representation type requested. */
+    body?: BodyBulk;
+    /** Inline comment resolution status */
+    resolutionStatus?: InlineCommentResolutionStatus;
+    properties?: InlineCommentProperties;
+    _links?: CommentLinks;
+}
+export interface InlineCommentModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the blog post containing the comment if the comment is on a blog post. */
+    blogPostId?: string;
+    /** ID of the page containing the comment if the comment is on a page. */
+    pageId?: string;
+    /** ID of the parent comment if the comment is a reply. */
+    parentCommentId?: string;
+    version?: Version;
+    /** Contains fields for each representation type requested. */
+    body?: BodySingle;
+    /**
+     * Atlassian Account ID of last person who modified the resolve state of the
+     * comment. Null until comment is resolved or reopened.
+     */
+    resolutionLastModifierId?: string;
+    /**
+     * Timestamp of the last modification to the comment's resolution status. Null
+     * until comment is resolved or reopened.
+     */
+    resolutionLastModifiedAt?: string;
+    /** Inline comment resolution status */
+    resolutionStatus?: InlineCommentResolutionStatus;
+    properties?: {
+        results?: ContentProperty[];
+        meta?: OptionalFieldMeta;
+        _links?: OptionalFieldLinks;
+        /** Property value used to reference the highlighted element in DOM. */
+        inlineMarkerRef?: string;
+        /** Text that is highlighted. */
+        inlineOriginalSelection?: string;
+        /**
+         * Deprecated, use `inlineMarkerRef` instead.
+         *
+         * @deprecated
+         * @deprecated
+         */
+        "inline-marker-ref"?: string;
+        /**
+         * Deprecated, use `inlineOriginalSelection` instead.
+         *
+         * @deprecated
+         * @deprecated
+         */
+        "inline-original-selection"?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    operations?: {
+        results?: Operation[];
+        meta?: OptionalFieldMeta;
+        _links?: OptionalFieldLinks;
+    } & {
+        [key: string]: unknown;
+    };
+    likes?: {
+        results?: Like[];
+        meta?: OptionalFieldMeta;
+        _links?: OptionalFieldLinks;
+    } & {
+        [key: string]: unknown;
+    };
+    versions?: {
+        results?: Version[];
+        meta?: OptionalFieldMeta;
+        _links?: OptionalFieldLinks;
+    } & {
+        [key: string]: unknown;
+    };
+    _links?: CommentLinks;
+}
+export interface InlineCommentProperties extends Record<string, unknown> {
+    /** Property value used to reference the highlighted element in DOM. */
+    inlineMarkerRef?: string;
+    /** Text that is highlighted. */
+    inlineOriginalSelection?: string;
+    /**
+     * Deprecated, use `inlineMarkerRef` instead.
+     *
+     * @deprecated
+     * @deprecated
+     */
+    "inline-marker-ref"?: string;
+    /**
+     * Deprecated, use `inlineOriginalSelection` instead.
+     *
+     * @deprecated
+     * @deprecated
+     */
+    "inline-original-selection"?: string;
+}
+/** Inline comment resolution status */
+export type InlineCommentResolutionStatus = "open" | "reopened" | "resolved" | "dangling";
+export interface PageCommentModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the page the comment is in. */
+    pageId?: string;
+    version?: Version;
+    /** Contains fields for each representation type requested. */
+    body?: BodyBulk;
+    _links?: CommentLinks;
+}
+export interface PageInlineCommentModel extends Record<string, unknown> {
+    /** ID of the comment. */
+    id?: string;
+    /** The status of the content. */
+    status?: ContentStatus;
+    /** Title of the comment. */
+    title?: string;
+    /** ID of the page the comment is in. */
+    pageId?: string;
+    version?: Version;
+    /** Contains fields for each representation type requested. */
+    body?: BodyBulk;
+    /** Inline comment resolution status */
+    resolutionStatus?: InlineCommentResolutionStatus;
+    properties?: InlineCommentProperties;
+    _links?: CommentLinks;
+}
+export interface UpdateFooterCommentModel extends Record<string, unknown> {
+    version?: {
+        /** Number of new version. Should be 1 higher than current version of the comment. */
+        number?: number;
+        /** Optional message store for the new version. */
+        message?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    body?: CommentBodyWrite | CommentNestedBodyWrite;
+}
+export interface UpdateInlineCommentModel extends Record<string, unknown> {
+    version?: {
+        /** Number of new version. Should be 1 higher than current version of the comment. */
+        number?: number;
+        /** Optional message store for the new version. */
+        message?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    body?: CommentBodyWrite | CommentNestedBodyWrite;
+    /**
+     * Resolved state of the comment. Set to true to resolve the comment, set to false
+     * to reopen it. If
+     * matching the existing state (i.e. true -> resolved or false -> open/reopened) ,
+     * no change will occur. A dangling
+     * comment cannot be updated.
+     */
+    resolved?: boolean;
+}
+export declare function registerCommentValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;