@resolution/confluence-api-client 0.2.0

package/lib/openapi/v1/models/common.d.ts

@@ -0,0 +1,645 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+import { type ContentChildType, type ContentHistory, type ContentLookAndFeel, type ContentMetadata, type Embeddable, type GroupArray, type HeaderLookAndFeel, type HorizontalHeaderLookAndFeel, type MenusLookAndFeel, type SpaceDescriptionV1, type SpacePermissionV1, type SuperBatchWebResources, type UsersUserKeys } from "./content";
+export interface AsyncId extends Record<string, unknown> {
+    asyncId: string;
+}
+/**
+ * Container for content. This can be either a space (containing a page or
+ * blogpost)
+ * or a page/blog post (containing an attachment or comment)
+ */
+export interface Container {
+    [key: string]: unknown;
+}
+/** Base object for all content types. */
+export interface Content extends Record<string, unknown> {
+    id?: string;
+    /** Can be "page", "blogpost", "attachment" or "content" */
+    type: string;
+    status: string;
+    title?: string;
+    space?: Space | null;
+    history?: ContentHistory | null;
+    version?: VersionV1 | null;
+    ancestors?: (Content | null)[] | null;
+    operations?: OperationCheckResult[];
+    children?: ContentChildren;
+    /**
+     * Shows whether a piece of content has attachments, comments, or child
+     * pages/whiteboards.
+     * Note, this doesn't actually contain the child objects.
+     */
+    childTypes?: ContentChildType;
+    descendants?: ContentChildren;
+    /**
+     * Container for content. This can be either a space (containing a page or
+     * blogpost)
+     * or a page/blog post (containing an attachment or comment)
+     */
+    container?: Container | null;
+    body?: {
+        view?: ContentBody;
+        export_view?: ContentBody;
+        styled_view?: ContentBody;
+        storage?: ContentBody;
+        wiki?: ContentBody;
+        editor?: ContentBody;
+        editor2?: ContentBody;
+        anonymous_export_view?: ContentBody;
+        atlas_doc_format?: ContentBody;
+        dynamic?: ContentBody;
+        raw?: ContentBody;
+        _expandable?: {
+            editor?: string;
+            view?: string;
+            export_view?: string;
+            styled_view?: string;
+            storage?: string;
+            editor2?: string;
+            anonymous_export_view?: string;
+            atlas_doc_format?: string;
+            wiki?: string;
+            dynamic?: string;
+            raw?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    };
+    restrictions?: {
+        read?: ContentRestriction;
+        update?: ContentRestriction;
+        _expandable?: {
+            read?: string;
+            update?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        _links?: GenericLinks;
+    } & {
+        [key: string]: unknown;
+    };
+    /** Metadata object for page, blogpost, comment content */
+    metadata?: ContentMetadata;
+    macroRenderedOutput?: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    };
+    extensions?: {
+        [key: string]: unknown;
+    };
+    _expandable?: {
+        childTypes?: string;
+        container?: string;
+        metadata?: string;
+        operations?: string;
+        children?: string;
+        restrictions?: string;
+        history?: string;
+        ancestors?: string;
+        body?: string;
+        version?: string;
+        descendants?: string;
+        space?: string;
+        extensions?: string;
+        schedulePublishDate?: string;
+        schedulePublishInfo?: string;
+        macroRenderedOutput?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links?: GenericLinks;
+}
+export interface ContentArray extends Record<string, unknown> {
+    results: (Content | null)[];
+    start?: number;
+    limit?: number;
+    size: number;
+    _links: GenericLinks;
+}
+export interface ContentBody extends Record<string, unknown> {
+    value: string;
+    representation: "view" | "export_view" | "styled_view" | "storage" | "editor" | "editor2" | "anonymous_export_view" | "wiki" | "atlas_doc_format" | "raw";
+    embeddedContent?: EmbeddedContent[];
+    webresource?: WebResourceDependencies;
+    mediaToken?: {
+        collectionIds?: string[];
+        contentId?: string;
+        expiryDateTime?: string;
+        fileIds?: string[];
+        token?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _expandable?: {
+        content?: string;
+        embeddedContent?: string;
+        webresource?: string;
+        mediaToken?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links?: GenericLinks;
+}
+/** This object is used when creating or updating content. */
+export interface ContentBodyCreate extends Record<string, unknown> {
+    /** The body of the content in the relevant format. */
+    value: string;
+    /**
+     * The content format type. Set the value of this property to
+     * the name of the format being used, e.g. 'storage'.
+     */
+    representation: "view" | "export_view" | "styled_view" | "storage" | "editor" | "editor2" | "anonymous_export_view" | "wiki" | "atlas_doc_format" | "plain" | "raw";
+}
+export interface ContentChildren extends Record<string, unknown> {
+    attachment?: ContentArray;
+    comment?: ContentArray;
+    page?: ContentArray;
+    whiteboard?: ContentArray;
+    database?: ContentArray;
+    embed?: ContentArray;
+    folder?: ContentArray;
+    _expandable?: {
+        attachment?: string;
+        comment?: string;
+        page?: string;
+        whiteboard?: string;
+        database?: string;
+        embed?: string;
+        folder?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links?: GenericLinks;
+}
+export type ContentId = string;
+export interface ContentRestriction extends Record<string, unknown> {
+    operation: "administer" | "copy" | "create" | "delete" | "export" | "move" | "purge" | "purge_version" | "read" | "restore" | "update" | "use";
+    restrictions?: {
+        user?: UserArray;
+        group?: GroupArray;
+        _expandable?: {
+            user?: string;
+            group?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    };
+    /** Base object for all content types. */
+    content?: Content | null;
+    _expandable: {
+        restrictions?: string;
+        content?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links: GenericLinks;
+}
+export interface EmbeddedContent extends Record<string, unknown> {
+    entityId?: number;
+    entityType?: string;
+    entity?: Embeddable;
+}
+/**
+ * The account ID of the user, which uniquely identifies the user across all
+ * Atlassian products.
+ * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
+ */
+export type GenericAccountId = string;
+export interface GenericLinks {
+    [key: string]: {
+        [key: string]: unknown;
+    } | string;
+}
+/**
+ * This property is no longer available and will be removed from the documentation
+ * soon.
+ * Use `accountId` instead.
+ * See the [deprecation
+ * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+ * for details.
+ */
+export type GenericUserKey = string;
+/**
+ * This property is no longer available and will be removed from the documentation
+ * soon.
+ * Use `accountId` instead.
+ * See the [deprecation
+ * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+ * for details.
+ */
+export type GenericUserName = string;
+export interface Group extends Record<string, unknown> {
+    type: "group";
+    name: string;
+    id: string;
+    _links?: GenericLinks;
+}
+/** Same as GroupArray but with `_links` property. */
+export interface GroupArrayWithLinks extends Record<string, unknown> {
+    results: Group[];
+    start: number;
+    limit: number;
+    size: number;
+    /**
+     * This property will return total count of the objects before pagination is
+     * applied.
+     * This value is returned if `shouldReturnTotalSize` is set to `true`.
+     */
+    totalSize?: number;
+    _links: GenericLinks;
+}
+/**
+ * This object represents an icon. If used as a profilePicture, this may be
+ * returned as null, depending on the user's privacy setting.
+ */
+export interface Icon extends Record<string, unknown> {
+    path: string;
+    width: number;
+    height: number;
+    isDefault: boolean;
+}
+export interface LabelArray extends Record<string, unknown> {
+    results: LabelV1[];
+    start?: number;
+    limit?: number;
+    size: number;
+    _links?: GenericLinks;
+}
+export interface LabelCreate extends Record<string, unknown> {
+    /** The prefix for the label. `global`, `my` `team`, etc. */
+    prefix: string;
+    /** The name of the label, which will be shown in the UI. */
+    name: string;
+}
+export interface LabelV1 extends Record<string, unknown> {
+    prefix: string;
+    name: string;
+    id: string;
+    label: string;
+}
+export interface LongTask extends Record<string, unknown> {
+    /** the ARI for the long task, based on its ID */
+    ari?: string;
+    /** a unique identifier for the long task */
+    id: string;
+    links: {
+        /** The URL to retrive status of long task. */
+        status?: string;
+    } & {
+        [key: string]: unknown;
+    };
+}
+export interface LookAndFeel extends Record<string, unknown> {
+    headings: {
+        color: string;
+    } & {
+        [key: string]: unknown;
+    };
+    links: {
+        color: string;
+    } & {
+        [key: string]: unknown;
+    };
+    menus: MenusLookAndFeel;
+    header: HeaderLookAndFeel;
+    horizontalHeader?: HorizontalHeaderLookAndFeel;
+    content: ContentLookAndFeel;
+    bordersAndDividers: {
+        color: string;
+    } & {
+        [key: string]: unknown;
+    };
+    spaceReference?: {
+        [key: string]: unknown;
+    } | null;
+}
+export interface Message extends Record<string, unknown> {
+    translation?: string;
+    args: (string | {
+        [key: string]: unknown;
+    })[];
+}
+/** An operation and the target entity that it applies to, e.g. create page. */
+export interface OperationCheckResult extends Record<string, unknown> {
+    /** The operation itself. */
+    operation: "administer" | "archive" | "clear_permissions" | "copy" | "create" | "create_space" | "delete" | "export" | "move" | "purge" | "purge_version" | "read" | "restore" | "restrict_content" | "update" | "use";
+    /**
+     * The space or content type that the operation applies to. Could be one of- -
+     * application - page - blogpost - comment - attachment - space
+     */
+    targetType: string;
+}
+export interface Space extends Record<string, unknown> {
+    id?: number;
+    key: string;
+    name: string;
+    /**
+     * This object represents an icon. If used as a profilePicture, this may be
+     * returned as null, depending on the user's privacy setting.
+     */
+    icon?: Icon | null;
+    description?: {
+        plain?: SpaceDescriptionV1;
+        view?: SpaceDescriptionV1;
+        _expandable?: {
+            view?: string;
+            plain?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    };
+    /** Base object for all content types. */
+    homepage?: Content | null;
+    type: string;
+    metadata?: {
+        labels?: LabelArray;
+        _expandable?: {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    };
+    operations?: OperationCheckResult[];
+    permissions?: SpacePermissionV1[];
+    status: string;
+    settings?: SpaceSettings | null;
+    theme?: Theme;
+    lookAndFeel?: LookAndFeel;
+    history?: {
+        createdDate: string;
+        createdBy?: User | null;
+    } & {
+        [key: string]: unknown;
+    };
+    _expandable: {
+        settings?: string;
+        metadata?: string;
+        operations?: string;
+        lookAndFeel?: string;
+        permissions?: string;
+        icon?: string;
+        description?: string;
+        theme?: string;
+        history?: string;
+        homepage?: string;
+        identifiers?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links: GenericLinks;
+}
+export interface SpaceSettings extends Record<string, unknown> {
+    /**
+     * Defines whether an override for the space home should be used. This is
+     * used in conjunction with a space theme provided by an app. For
+     * example, if this property is set to true, a theme can display a page
+     * other than the space homepage when users visit the root URL for a
+     * space. This property allows apps to provide content-only theming
+     * without overriding the space home.
+     */
+    routeOverrideEnabled: boolean;
+    editor?: {
+        page: string;
+        blogpost: string;
+        default: string;
+    } & {
+        [key: string]: unknown;
+    };
+    spaceKey?: string;
+    _links: GenericLinks;
+}
+export interface Theme extends Record<string, unknown> {
+    themeKey: string;
+    name?: string;
+    description?: string;
+    /**
+     * This object represents an icon. If used as a profilePicture, this may be
+     * returned as null, depending on the user's privacy setting.
+     */
+    icon?: Icon | null;
+    _links?: GenericLinks;
+}
+export interface User extends Record<string, unknown> {
+    type: "known" | "unknown" | "anonymous" | "user";
+    /**
+     * This property is no longer available and will be removed from the documentation
+     * soon.
+     * Use `accountId` instead.
+     * See the [deprecation
+     * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    username?: GenericUserName | null;
+    /**
+     * This property is no longer available and will be removed from the documentation
+     * soon.
+     * Use `accountId` instead.
+     * See the [deprecation
+     * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    userKey?: GenericUserKey | null;
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products.
+     * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
+     */
+    accountId?: GenericAccountId | null;
+    /**
+     * The account type of the user, may return empty string if unavailable. App is if
+     * the user is a bot user created on behalf of an Atlassian app.
+     */
+    accountType?: "atlassian" | "app" | "";
+    /**
+     * The email address of the user. Depending on the user's privacy setting, this
+     * may return an empty string.
+     */
+    email?: string | null;
+    /** The public name or nickname of the user. Will always contain a value. */
+    publicName?: string;
+    /**
+     * This object represents an icon. If used as a profilePicture, this may be
+     * returned as null, depending on the user's privacy setting.
+     */
+    profilePicture?: Icon | null;
+    /**
+     * The displays name of the user. Depending on the user's privacy setting, this
+     * may be the same as publicName.
+     */
+    displayName?: string | null;
+    /**
+     * This displays user time zone. Depending on the user's privacy setting, this may
+     * return null.
+     */
+    timeZone?: string | null;
+    /** Whether the user is an external collaborator user */
+    isExternalCollaborator?: boolean;
+    /** Whether the user is an external collaborator user */
+    externalCollaborator?: boolean;
+    operations?: OperationCheckResult[] | null;
+    details?: UserDetails;
+    personalSpace?: Space | null;
+    _expandable?: {
+        operations?: string;
+        details?: string;
+        personalSpace?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links?: GenericLinks;
+}
+export interface UserArray extends Record<string, unknown> {
+    results: (User | null)[];
+    start?: number;
+    limit?: number;
+    size?: number;
+    /**
+     * This property will return total count of the objects before pagination is
+     * applied.
+     * This value is returned if `shouldReturnTotalSize` is set to `true`.
+     */
+    totalSize?: number;
+    _links?: GenericLinks;
+}
+export interface UserDetails extends Record<string, unknown> {
+    business?: {
+        /**
+         * This property has been deprecated due to privacy changes. There is no
+         * replacement. See the
+         * [migration
+         * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        position?: string;
+        /**
+         * This property has been deprecated due to privacy changes. There is no
+         * replacement. See the
+         * [migration
+         * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        department?: string;
+        /**
+         * This property has been deprecated due to privacy changes. There is no
+         * replacement. See the
+         * [migration
+         * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        location?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    personal?: {
+        /**
+         * This property has been deprecated due to privacy changes. There is no
+         * replacement. See the
+         * [migration
+         * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        phone?: string;
+        /**
+         * This property has been deprecated due to privacy changes. There is no
+         * replacement. See the
+         * [migration
+         * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        im?: string;
+        /**
+         * This property has been deprecated due to privacy changes. There is no
+         * replacement. See the
+         * [migration
+         * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        website?: string;
+        /**
+         * This property has been deprecated due to privacy changes. Use the `User.email`
+         * property instead. See the
+         * [migration
+         * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+         * for details.
+         */
+        email?: string;
+    } & {
+        [key: string]: unknown;
+    };
+}
+export interface VersionV1 extends Record<string, unknown> {
+    by?: User | null;
+    when: string | null;
+    friendlyWhen?: string | null;
+    message?: string | null;
+    /** Set this to the current version number incremented by one */
+    number: number;
+    /**
+     * If `minorEdit` is set to 'true', no notification email or activity
+     * stream will be generated for the change.
+     */
+    minorEdit: boolean;
+    /** Base object for all content types. */
+    content?: Content | null;
+    collaborators?: UsersUserKeys | null;
+    _expandable?: {
+        content?: string;
+        collaborators?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links?: GenericLinks;
+    /** True if content type is modifed in this version (e.g. page to blog) */
+    contentTypeModified?: boolean;
+    /** The revision id provided by confluence to be used as a revision in Synchrony */
+    confRev?: string | null;
+    /** The revision id provided by Synchrony */
+    syncRev?: string | null;
+    /** Source of the synchrony revision */
+    syncRevSource?: string | null;
+}
+export interface WebResourceDependencies extends Record<string, unknown> {
+    _expandable?: {
+        uris?: string | {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    };
+    keys?: string[];
+    contexts?: string[];
+    uris?: {
+        all?: string[] | string;
+        css?: string[] | string;
+        js?: string[] | string;
+        _expandable?: {
+            css?: string[] | string;
+            js?: string[] | string;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    };
+    tags?: {
+        all?: string;
+        css?: string;
+        data?: string;
+        js?: string;
+        _expandable?: {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    };
+    superbatch?: SuperBatchWebResources;
+}
+export declare function registerCommonValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;