confluence.js 1.7.4 → 2.0.0-dev20250512104821

package/dist/esm/types/api/models/attachment.d.ts

@@ -0,0 +1,31 @@
+import type { AttachmentMetadata } from "./attachmentMetadata.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface Attachment {
+    id: string;
+    type: "attachment" | string;
+    status: "current" | string;
+    title: string;
+    macroRenderedOutput: any;
+    metadata: AttachmentMetadata;
+    extensions: {
+        mediaType: string;
+        fileSize: number;
+        comment: string;
+        mediaTypeDescription: string;
+        fileId: string;
+        collectionName?: string;
+    };
+    _expandable: {
+        childTypes: string;
+        operations: string;
+        schedulePublishDate: string;
+        children: string;
+        restrictions: string;
+        history: string;
+        ancestors: string;
+        body: string;
+        descendants: string;
+        space: string;
+    };
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/attachmentContainer.d.ts

@@ -0,0 +1,27 @@
+import type { GenericLinks } from "./genericLinks.js";
+export interface AttachmentContainer {
+    id: string;
+    type: "page" | "string";
+    status: "current" | string;
+    title: string;
+    macroRenderedOutput: any;
+    extensions: {
+        position: number;
+    };
+    _expandable: {
+        container: string;
+        metadata: string;
+        restrictions: string;
+        history: string;
+        body: string;
+        version: string;
+        descendants: string;
+        space: string;
+        childTypes: string;
+        operations: string;
+        schedulePublishDate: string;
+        children: string;
+        ancestors: string;
+    };
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/attachmentMetadata.d.ts

@@ -0,0 +1,20 @@
+import type { GenericLinks } from "./genericLinks.js";
+export interface AttachmentMetadata {
+    comment: string;
+    mediaType: string;
+    labels: {
+        results: string[];
+        start: number;
+        limit: number;
+        size: number;
+        _links: GenericLinks;
+    };
+    _expandable: {
+        currentuser: string;
+        comments: string;
+        simple: string;
+        properties: string;
+        frontend: string;
+        likes: string;
+    };
+}

package/dist/esm/types/api/models/auditRecord.d.ts

@@ -0,0 +1,19 @@
+import type { AffectedObject } from "./affectedObject.js";
+import type { ChangedValue } from "./changedValue.js";
+export interface AuditRecord {
+    author: {
+        type: string;
+        displayName: string;
+        operations: {};
+    };
+    remoteAddress: string;
+    /** The creation date-time of the audit record, as a timestamp. */
+    creationDate: number;
+    summary: string;
+    description: string;
+    category: string;
+    sysAdmin: boolean;
+    affectedObject: AffectedObject;
+    changedValues: ChangedValue[];
+    associatedObjects: AffectedObject[];
+}

package/dist/esm/types/api/models/auditRecordArray.d.ts

@@ -0,0 +1,9 @@
+import type { AuditRecord } from "./auditRecord.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface AuditRecordArray {
+    results: AuditRecord[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/auditRecordCreate.d.ts

@@ -0,0 +1,43 @@
+import type { AffectedObject } from "./affectedObject.js";
+import type { ChangedValue } from "./changedValue.js";
+export interface AuditRecordCreate {
+    /**
+     * The user that actioned the event. If `author` is not specified, then all `author` properties will be set to
+     * null/empty, except for `type` which will be set to 'user'.
+     */
+    author?: {
+        /** Set to 'user'. */
+        type: string;
+        /** The name that is displayed on the audit log in the Confluence UI. */
+        displayName?: string;
+        /** Always defaults to null. */
+        operations?: {};
+    };
+    /** The IP address of the computer where the event was initiated from. */
+    remoteAddress: string;
+    /**
+     * The creation date-time of the audit record, as a timestamp. This is converted to a date-time display in the
+     * Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current
+     * date-time.
+     */
+    creationDate?: number;
+    /** The summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI. */
+    summary?: string;
+    /**
+     * A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence
+     * UI.
+     */
+    description?: string;
+    /** The category of the event, which is displayed in the 'Event type' column on the audit log in the Confluence UI. */
+    category?: string;
+    /** Indicates whether the event was actioned by a system administrator. */
+    sysAdmin?: boolean;
+    affectedObject?: AffectedObject;
+    /** The values that were changed in the event. */
+    changedValues?: ChangedValue[];
+    /**
+     * Objects that were associated with the event. For example, if the event was a space permission change then the
+     * associated object would be the space.
+     */
+    associatedObjects?: AffectedObject[];
+}

package/dist/esm/types/api/models/availableContentStates.d.ts

@@ -0,0 +1,6 @@
+import type { ContentState } from "./contentState.js";
+export interface AvailableContentStates {
+    /** Space suggested content states that can be used in the space */
+    spaceContentStates: ContentState[];
+    customContentStates: ContentState[];
+}

package/dist/esm/types/api/models/blueprintTemplate.d.ts

@@ -0,0 +1,20 @@
+import type { ContentBody } from "./contentBody.js";
+import type { GenericLinks } from "./genericLinks.js";
+import type { Label } from "./label.js";
+export interface BlueprintTemplate {
+    templateId: string;
+    originalTemplate: {
+        pluginKey: string;
+        moduleKey: string;
+    };
+    referencingBlueprint: string;
+    name: string;
+    description: string;
+    labels: Label[];
+    templateType: string;
+    body?: ContentBody;
+    _expandable: {
+        body?: string;
+    };
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/blueprintTemplateArray.d.ts

@@ -0,0 +1,9 @@
+import type { BlueprintTemplate } from "./blueprintTemplate.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface BlueprintTemplateArray {
+    results: BlueprintTemplate[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/bulkUserLookup.d.ts

@@ -0,0 +1,39 @@
+import type { GenericLinks } from "./genericLinks.js";
+import type { Icon } from "./icon.js";
+import type { OperationCheckResult } from "./operationCheckResult.js";
+import type { Space } from "./space.js";
+export interface BulkUserLookup {
+    type: 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.
+     */
+    username?: 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.
+     */
+    userKey?: string;
+    /**
+     * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
+     * `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
+     */
+    accountId: string;
+    /** The account type of the user, may return empty string if unavailable. */
+    accountType: string;
+    /** The email address of the user. Depending on the user's privacy setting, this may return an empty string. */
+    email: string;
+    /** The public name or nickname of the user. Will always contain a value. */
+    publicName: string;
+    profilePicture: Icon;
+    /** The display name of the user. Depending on the user's privacy setting, this may be the same as publicName. */
+    displayName: string;
+    operations?: OperationCheckResult[];
+    personalSpace?: Space;
+    _expandable: {
+        operations?: string;
+        details?: string;
+        personalSpace?: string;
+    };
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/bulkUserLookupArray.d.ts

@@ -0,0 +1,9 @@
+import type { BulkUserLookup } from "./bulkUserLookup.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface BulkUserLookupArray {
+    results: BulkUserLookup[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/connectModules.d.ts

@@ -0,0 +1,6 @@
+import type { AppDescriptor } from "./appDescriptor.js";
+/**
+ * A list of app modules in the same format as the `modules` property in the [app
+ * descriptor](https://developer.atlassian.com/cloud/confluence/app-descriptor/).
+ */
+export type ConnectModules = AppDescriptor[];

package/dist/esm/types/api/models/content.d.ts

@@ -0,0 +1,65 @@
+import type { Container } from "./container.js";
+import type { ContentBody } from "./contentBody.js";
+import type { ContentChildren } from "./contentChildren.js";
+import type { ContentChildType } from "./contentChildType.js";
+import type { ContentHistory } from "./contentHistory.js";
+import type { ContentRestriction } from "./contentRestriction.js";
+import type { GenericLinks } from "./genericLinks.js";
+import type { OperationCheckResult } from "./operationCheckResult.js";
+import type { Space } from "./space.js";
+import type { Version } from "./version.js";
+/** Base object for all content types. */
+export interface Content {
+    id: string;
+    type: string;
+    status: string;
+    title: string;
+    space?: Space;
+    history?: ContentHistory;
+    version?: Version;
+    ancestors?: Content[];
+    operations?: OperationCheckResult[];
+    children?: ContentChildren;
+    childTypes?: ContentChildType;
+    descendants?: ContentChildren;
+    container?: Container;
+    body?: {
+        view?: ContentBody;
+        export_view?: ContentBody;
+        styled_view?: ContentBody;
+        storage?: ContentBody;
+        editor2?: ContentBody;
+        anonymous_export_view?: ContentBody;
+        atlas_doc_format?: ContentBody;
+        _expandable: {
+            editor?: string;
+            view?: string;
+            export_view?: string;
+            styled_view?: string;
+            storage?: string;
+            editor2?: string;
+            anonymous_export_view?: string;
+            atlas_doc_format?: string;
+        };
+    };
+    restrictions?: {
+        read?: ContentRestriction;
+        update?: ContentRestriction;
+        _links: GenericLinks;
+    };
+    _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;
+    };
+    _links?: GenericLinks;
+}

package/dist/esm/types/api/models/contentArray.d.ts

@@ -0,0 +1,9 @@
+import type { Content } from "./content.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface ContentArray<T = Content> {
+    results: T[];
+    start?: number;
+    limit?: number;
+    size: number;
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/contentBody.d.ts

@@ -0,0 +1,11 @@
+import type { EmbeddedContent } from "./embeddedContent.js";
+import type { WebResourceDependencies } from "./webResourceDependencies.js";
+export interface ContentBody {
+    value: string;
+    representation: string;
+    embeddedContent?: EmbeddedContent[];
+    webresource?: WebResourceDependencies;
+    _expandable: {
+        content?: string;
+    };
+}

package/dist/esm/types/api/models/contentChildType.d.ts

@@ -0,0 +1,25 @@
+import type { GenericLinks } from "./genericLinks.js";
+/**
+ * Shows whether a piece of content has attachments, comments, or child pages.* Note, this doesn't actually contain the
+ * child objects.
+ */
+export interface ContentChildType {
+    attachment?: {
+        value: boolean;
+        _links: GenericLinks;
+    };
+    comment?: {
+        value: boolean;
+        _links: GenericLinks;
+    };
+    page?: {
+        value: boolean;
+        _links: GenericLinks;
+    };
+    _expandable: {
+        all?: string;
+        attachment?: string;
+        comment?: string;
+        page?: string;
+    };
+}

package/dist/esm/types/api/models/contentChildren.d.ts

@@ -0,0 +1,13 @@
+import type { ContentArray } from "./contentArray.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface ContentChildren {
+    attachment?: ContentArray;
+    comment?: ContentArray;
+    page?: ContentArray;
+    _expandable: {
+        attachment?: string;
+        comment?: string;
+        page?: string;
+    };
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/contentCreate.d.ts

@@ -0,0 +1,60 @@
+import type { ContentBodyCreate } from "./contentBodyCreate.js";
+export interface ContentCreate {
+    /** The ID of the draft content. Required when publishing a draft. */
+    id?: string;
+    title: string;
+    /** The type of the new content. Custom content types defined by apps are also supported. */
+    type: string | "page" | "blogpost" | "comment";
+    /** The space that the content is being created in. */
+    space: {
+        /** The key of the space. */
+        key: string;
+    };
+    /** The status of the new content. */
+    status?: string;
+    /**
+     * The container of the content. Required if type is `comment` or certain types of custom content. If you are trying
+     * to create a comment that is a child of another comment, specify the parent comment in the ancestors field, not in
+     * this field.
+     */
+    container?: {
+        /** The `id` of the container. */
+        id: string;
+        /** The `type` of the container. */
+        type: string;
+    };
+    /**
+     * The parent content of the new content. If you are creating a top-level `page` or `comment`, this can be left blank.
+     * If you are creating a child page, this is where the parent page id goes. If you are creating a child comment, this
+     * is where the parent comment id goes. Only one parent content id can be specified.
+     */
+    ancestors?: {
+        /** The `id` of the parent content. */
+        id: string;
+    }[];
+    /**
+     * The body of the new content. Does not apply to attachments. Only one body format should be specified as the
+     * property for this object, e.g. `storage`.
+     *
+     * Note, `editor2` format is used by Atlassian only. `anonymous_export_view` is the same as 'export_view' format but
+     * only content viewable by an anonymous user is included.
+     */
+    body?: {
+        view?: ContentBodyCreate;
+        export_view?: ContentBodyCreate;
+        styled_view?: ContentBodyCreate;
+        storage?: ContentBodyCreate;
+        editor2?: ContentBodyCreate;
+        anonymous_export_view?: ContentBodyCreate;
+        atlas_doc_format?: ContentBodyCreate;
+    };
+    /**
+     * The new version for the created content.
+     *
+     * To get the current version number, use [Get content by ID](#api-content-id-get) and retrieve `version.number`.
+     */
+    version?: {
+        /** The version comment. */
+        message?: string;
+    };
+}

package/dist/esm/types/api/models/contentHistory.d.ts

@@ -0,0 +1,22 @@
+import type { GenericLinks } from "./genericLinks.js";
+import type { User } from "./user.js";
+import type { UsersUserKeys } from "./usersUserKeys.js";
+import type { Version } from "./version.js";
+export interface ContentHistory {
+    latest: boolean;
+    createdBy: User;
+    createdDate: string;
+    lastUpdated?: Version;
+    previousVersion?: Version;
+    contributors?: {
+        publishers?: UsersUserKeys;
+    };
+    nextVersion?: Version;
+    _expandable?: {
+        lastUpdated?: string;
+        previousVersion?: string;
+        contributors?: string;
+        nextVersion?: string;
+    };
+    _links?: GenericLinks;
+}

package/dist/esm/types/api/models/contentLookAndFeel.d.ts

@@ -0,0 +1,8 @@
+import type { ContainerLookAndFeel } from "./containerLookAndFeel.js";
+import type { ScreenLookAndFeel } from "./screenLookAndFeel.js";
+export interface ContentLookAndFeel {
+    screen: ScreenLookAndFeel;
+    container: ContainerLookAndFeel;
+    header: ContainerLookAndFeel;
+    body: ContainerLookAndFeel;
+}

package/dist/esm/types/api/models/contentPermissionRequest.d.ts

@@ -0,0 +1,7 @@
+import type { PermissionSubjectWithGroupId } from "./permissionSubjectWithGroupId.js";
+/** This object represents the request for the content permission check API. */
+export interface ContentPermissionRequest {
+    subject: PermissionSubjectWithGroupId;
+    /** The content permission operation to check. */
+    operation: string;
+}

package/dist/esm/types/api/models/contentProperty.d.ts

@@ -0,0 +1,16 @@
+import type { Content } from "./content.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface ContentProperty {
+    id: number;
+    key: string;
+    /** The value of the content property. This can be empty or a complex object. */
+    value: {};
+    version?: {
+        when: string;
+        message: string;
+        number: number;
+        minorEdit: boolean;
+    };
+    content?: Content;
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/contentPropertyArray.d.ts

@@ -0,0 +1,9 @@
+import type { ContentProperty } from "./contentProperty.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface ContentPropertyArray {
+    results: ContentProperty[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/contentPropertyCreate.d.ts

@@ -0,0 +1,6 @@
+import type { PropertyValue } from "./propertyValue.js";
+export interface ContentPropertyCreate {
+    /** The key of the new property. */
+    key: string;
+    value: PropertyValue;
+}

package/dist/esm/types/api/models/contentPropertyCreateNoKey.d.ts

@@ -0,0 +1,4 @@
+import type { PropertyValue } from "./propertyValue.js";
+export interface ContentPropertyCreateNoKey {
+    value: PropertyValue;
+}

package/dist/esm/types/api/models/contentRestriction.d.ts

@@ -0,0 +1,21 @@
+import type { Content } from "./content.js";
+import type { GenericLinks } from "./genericLinks.js";
+import type { GroupArray } from "./groupArray.js";
+import type { UserArray } from "./userArray.js";
+export interface ContentRestriction {
+    operation: string;
+    restrictions?: {
+        user?: UserArray;
+        group?: GroupArray;
+        _expandable?: {
+            user?: string;
+            group?: string;
+        };
+    };
+    content?: Content;
+    _expandable: {
+        restrictions?: string;
+        content?: string;
+    };
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/contentRestrictionArray.d.ts

@@ -0,0 +1,11 @@
+import type { ContentRestriction } from "./contentRestriction.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface ContentRestrictionArray {
+    results: ContentRestriction[];
+    start: number;
+    limit: number;
+    size: number;
+    /** This property is used by the UI to figure out whether a set of restrictions has changed. */
+    restrictionsHash: string;
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/contentRestrictionUpdateArray.d.ts

@@ -0,0 +1,2 @@
+import type { ContentRestrictionUpdate } from "./contentRestrictionUpdate.js";
+export type ContentRestrictionUpdateArray = ContentRestrictionUpdate[];

package/dist/esm/types/api/models/contentStateResponse.d.ts

@@ -0,0 +1,7 @@
+import type { ContentState } from "./contentState.js";
+export interface ContentStateResponse {
+    /** Null or content state */
+    contentState?: ContentState;
+    /** Timestamp of last publish event where content state changed */
+    lastUpdated?: string;
+}

package/dist/esm/types/api/models/contentStateSettings.d.ts

@@ -0,0 +1,11 @@
+import type { ContentState } from "./contentState.js";
+export interface ContentStateSettings {
+    /** Whether users can place content states on any pages and blog posts in the space */
+    contentStatesAllowed: boolean;
+    /** Whether users can create custom states on the fly on pages and blog posts */
+    customContentStatesAllowed: boolean;
+    /** Whether space content states are allowed */
+    spaceContentStatesAllowed: boolean;
+    /** Space content states that users in the space can choose from */
+    spaceContentStates?: ContentState[];
+}

package/dist/esm/types/api/models/contentTemplate.d.ts

@@ -0,0 +1,15 @@
+import type { ContentBody } from "./contentBody.js";
+import type { GenericLinks } from "./genericLinks.js";
+import type { Label } from "./label.js";
+export interface ContentTemplate {
+    templateId: string;
+    name: string;
+    description: string;
+    labels: Label[];
+    templateType: string;
+    body?: ContentBody;
+    _expandable: {
+        body?: string;
+    };
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/contentTemplateArray.d.ts

@@ -0,0 +1,9 @@
+import type { ContentTemplate } from "./contentTemplate.js";
+import type { GenericLinks } from "./genericLinks.js";
+export interface ContentTemplateArray {
+    results: ContentTemplate[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+}

package/dist/esm/types/api/models/contentTemplateBodyCreate.d.ts

@@ -0,0 +1,5 @@
+import type { ContentBodyCreate } from "./contentBodyCreate.js";
+/** This object is used when creating or updating content. */
+export interface ContentTemplateBodyCreate {
+    storage?: ContentBodyCreate;
+}

package/dist/esm/types/api/models/contentTemplateCreate.d.ts

@@ -0,0 +1,21 @@
+import type { ContentTemplateBodyCreate } from "./contentTemplateBodyCreate.js";
+import type { Label } from "./label.js";
+/** This object is used to create content templates. */
+export interface ContentTemplateCreate {
+    /** The name of the new template. */
+    name: string;
+    /** The type of the new template. Set to `page`. */
+    templateType: string;
+    body: ContentTemplateBodyCreate;
+    /** A description of the new template. */
+    description?: string;
+    /** Labels for the new template. */
+    labels?: Label[];
+    /**
+     * The key for the space of the new template. Only applies to space templates. If the spaceKey is not specified, the
+     * template will be created as a global template.
+     */
+    space?: {
+        key: string;
+    };
+}