@aashari/mcp-server-atlassian-confluence
Version:
Node.js/TypeScript MCP server for Atlassian Confluence. Provides tools enabling AI systems (LLMs) to list/get spaces & pages (content formatted as Markdown) and search via CQL. Connects AI seamlessly to Confluence knowledge bases using the standard MCP in
1,683 lines • 55.9 kB
TypeScript
/**
* Types for Atlassian Confluence Pages API
*/
import { z } from 'zod';
/**
* Page status enum
*/
export type ContentStatus = 'current' | 'trashed' | 'deleted' | 'draft' | 'archived' | 'historical';
/**
* Page sort order enum
*/
export type PageSortOrder = 'id' | '-id' | 'created-date' | '-created-date' | 'modified-date' | '-modified-date' | 'title' | '-title';
/**
* Body format enum
*/
export type BodyFormat = 'storage' | 'atlas_doc_format' | 'view' | 'export_view' | 'anonymous_export_view' | 'styled_view' | 'editor';
/**
* Parameters for listing pages
*/
export interface ListPagesParams {
spaceId?: string[];
title?: string;
status?: ContentStatus[];
bodyFormat?: BodyFormat;
sort?: PageSortOrder;
query?: string;
cursor?: string;
limit?: number;
parentId?: string;
}
/**
* Parameters for getting a specific page
*/
export interface GetPageByIdParams {
bodyFormat?: BodyFormat;
getDraft?: boolean;
version?: number;
includeAncestors?: boolean;
includeBody?: boolean;
includeChildTypes?: boolean;
includeLabels?: boolean;
includeVersion?: boolean;
includeOperations?: boolean;
includeWebresources?: boolean;
includeCollaborators?: boolean;
}
/**
* Zod schemas for Confluence API response types
*/
/**
* Content status enum schema
*/
export declare const ContentStatusSchema: z.ZodEnum<["current", "deleted", "historical", "trashed", "archived", "draft"]>;
/**
* Content representation schema
*/
export declare const ContentRepresentationSchema: z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>;
/**
* Version schema
*/
export declare const VersionSchema: z.ZodObject<{
number: z.ZodNumber;
message: z.ZodOptional<z.ZodString>;
minorEdit: z.ZodOptional<z.ZodBoolean>;
authorId: z.ZodOptional<z.ZodString>;
createdAt: z.ZodOptional<z.ZodString>;
contentTypeModifiedAt: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
}, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
}>;
/**
* Body schema
*/
export declare const BodySchema: z.ZodObject<{
storage: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
export_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
styled_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
atlas_doc_format: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
wiki: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
anonymous_export_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
}, "strip", z.ZodTypeAny, {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
}, {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
}>;
/**
* Page links schema
*/
export declare const PageLinksSchema: z.ZodObject<{
webui: z.ZodOptional<z.ZodString>;
editui: z.ZodOptional<z.ZodString>;
tinyui: z.ZodOptional<z.ZodString>;
base: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
}, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
}>;
/**
* Web resource schema
*/
export declare const WebResourceSchema: z.ZodObject<{
key: z.ZodString;
contexts: z.ZodArray<z.ZodString, "many">;
superbatch: z.ZodString;
uris: z.ZodRecord<z.ZodString, z.ZodString>;
tags: z.ZodArray<z.ZodString, "many">;
}, "strip", z.ZodTypeAny, {
key: string;
contexts: string[];
superbatch: string;
uris: Record<string, string>;
tags: string[];
}, {
key: string;
contexts: string[];
superbatch: string;
uris: Record<string, string>;
tags: string[];
}>;
/**
* Page collaborator schema
*/
export declare const PageCollaboratorSchema: z.ZodObject<{
collaboratorId: z.ZodString;
businessObjectId: z.ZodString;
appearanceId: z.ZodString;
}, "strip", z.ZodTypeAny, {
collaboratorId: string;
businessObjectId: string;
appearanceId: string;
}, {
collaboratorId: string;
businessObjectId: string;
appearanceId: string;
}>;
/**
* Page parent schema
*/
export declare const PageParentSchema: z.ZodObject<{
id: z.ZodString;
type: z.ZodString;
status: z.ZodString;
title: z.ZodString;
}, "strip", z.ZodTypeAny, {
title: string;
status: string;
id: string;
type: string;
}, {
title: string;
status: string;
id: string;
type: string;
}>;
/**
* Child types schema
*/
export declare const ChildTypesSchema: z.ZodObject<{
attachment: z.ZodOptional<z.ZodBoolean>;
comment: z.ZodOptional<z.ZodBoolean>;
page: z.ZodOptional<z.ZodBoolean>;
}, "strip", z.ZodTypeAny, {
page?: boolean | undefined;
attachment?: boolean | undefined;
comment?: boolean | undefined;
}, {
page?: boolean | undefined;
attachment?: boolean | undefined;
comment?: boolean | undefined;
}>;
/**
* Label schema (moved from deleted vendor.atlassian.spaces.types.js)
*/
export declare const LabelSchema: z.ZodObject<{
id: z.ZodString;
name: z.ZodString;
prefix: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
id: string;
name: string;
prefix?: string | undefined;
}, {
id: string;
name: string;
prefix?: string | undefined;
}>;
/**
* Operation schema (moved from deleted vendor.atlassian.spaces.types.js)
*/
export declare const OperationSchema: z.ZodObject<{
key: z.ZodOptional<z.ZodString>;
target: z.ZodOptional<z.ZodString>;
targetType: z.ZodString;
}, "strip", z.ZodTypeAny, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}>;
/**
* Optional field metadata schema (moved from deleted vendor.atlassian.spaces.types.js)
*/
export declare const OptionalFieldMetaSchema: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
/**
* Optional field links schema (moved from deleted vendor.atlassian.spaces.types.js)
*/
export declare const OptionalFieldLinksSchema: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
/**
* Optional collection schema - used for labels, properties, operations, etc.
* (moved from deleted vendor.atlassian.spaces.types.js)
*/
export declare const OptionalCollectionSchema: <T extends z.ZodTypeAny>(itemSchema: T) => z.ZodObject<{
results: z.ZodArray<T, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: T["_output"][];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: T["_input"][];
meta: {
count?: number | undefined;
};
}>;
/**
* Base page schema (common fields)
*/
export declare const PageSchema: z.ZodObject<{
id: z.ZodString;
status: z.ZodEnum<["current", "deleted", "historical", "trashed", "archived", "draft"]>;
title: z.ZodString;
spaceId: z.ZodString;
parentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
parentType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
authorId: z.ZodOptional<z.ZodString>;
createdAt: z.ZodString;
position: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
version: z.ZodOptional<z.ZodObject<{
number: z.ZodNumber;
message: z.ZodOptional<z.ZodString>;
minorEdit: z.ZodOptional<z.ZodBoolean>;
authorId: z.ZodOptional<z.ZodString>;
createdAt: z.ZodOptional<z.ZodString>;
contentTypeModifiedAt: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
}, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
}>>;
_links: z.ZodObject<{
webui: z.ZodOptional<z.ZodString>;
editui: z.ZodOptional<z.ZodString>;
tinyui: z.ZodOptional<z.ZodString>;
base: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
}, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
}>;
body: z.ZodOptional<z.ZodObject<{
storage: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
export_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
styled_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
atlas_doc_format: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
wiki: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
anonymous_export_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
}, "strip", z.ZodTypeAny, {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
}, {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
title: string;
status: "current" | "archived" | "trashed" | "deleted" | "draft" | "historical";
id: string;
createdAt: string;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
};
spaceId: string;
authorId?: string | undefined;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
} | undefined;
parentId?: string | null | undefined;
parentType?: string | null | undefined;
position?: number | null | undefined;
body?: {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
} | undefined;
}, {
title: string;
status: "current" | "archived" | "trashed" | "deleted" | "draft" | "historical";
id: string;
createdAt: string;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
};
spaceId: string;
authorId?: string | undefined;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
} | undefined;
parentId?: string | null | undefined;
parentType?: string | null | undefined;
position?: number | null | undefined;
body?: {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
} | undefined;
}>;
/**
* Detailed page schema
*/
export declare const PageDetailedSchema: z.ZodObject<{
id: z.ZodString;
status: z.ZodEnum<["current", "deleted", "historical", "trashed", "archived", "draft"]>;
title: z.ZodString;
spaceId: z.ZodString;
parentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
parentType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
authorId: z.ZodOptional<z.ZodString>;
createdAt: z.ZodString;
position: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
version: z.ZodOptional<z.ZodObject<{
number: z.ZodNumber;
message: z.ZodOptional<z.ZodString>;
minorEdit: z.ZodOptional<z.ZodBoolean>;
authorId: z.ZodOptional<z.ZodString>;
createdAt: z.ZodOptional<z.ZodString>;
contentTypeModifiedAt: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
}, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
}>>;
_links: z.ZodObject<{
webui: z.ZodOptional<z.ZodString>;
editui: z.ZodOptional<z.ZodString>;
tinyui: z.ZodOptional<z.ZodString>;
base: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
}, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
}>;
body: z.ZodOptional<z.ZodObject<{
storage: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
export_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
styled_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
atlas_doc_format: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
wiki: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
anonymous_export_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
}, "strip", z.ZodTypeAny, {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
}, {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
}>>;
} & {
parent: z.ZodOptional<z.ZodObject<{
id: z.ZodString;
type: z.ZodString;
status: z.ZodString;
title: z.ZodString;
}, "strip", z.ZodTypeAny, {
title: string;
status: string;
id: string;
type: string;
}, {
title: string;
status: string;
id: string;
type: string;
}>>;
childTypes: z.ZodOptional<z.ZodObject<{
attachment: z.ZodOptional<z.ZodBoolean>;
comment: z.ZodOptional<z.ZodBoolean>;
page: z.ZodOptional<z.ZodBoolean>;
}, "strip", z.ZodTypeAny, {
page?: boolean | undefined;
attachment?: boolean | undefined;
comment?: boolean | undefined;
}, {
page?: boolean | undefined;
attachment?: boolean | undefined;
comment?: boolean | undefined;
}>>;
labels: z.ZodOptional<z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
id: z.ZodString;
name: z.ZodString;
prefix: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
id: string;
name: string;
prefix?: string | undefined;
}, {
id: string;
name: string;
prefix?: string | undefined;
}>, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
name: string;
prefix?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
name: string;
prefix?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
}>>;
operations: z.ZodOptional<z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
key: z.ZodOptional<z.ZodString>;
target: z.ZodOptional<z.ZodString>;
targetType: z.ZodString;
}, "strip", z.ZodTypeAny, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}, {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}>, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
}>>;
collaborators: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
collaboratorId: z.ZodString;
businessObjectId: z.ZodString;
appearanceId: z.ZodString;
}, "strip", z.ZodTypeAny, {
collaboratorId: string;
businessObjectId: string;
appearanceId: string;
}, {
collaboratorId: string;
businessObjectId: string;
appearanceId: string;
}>, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
collaboratorId: string;
businessObjectId: string;
appearanceId: string;
}[];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
collaboratorId: string;
businessObjectId: string;
appearanceId: string;
}[];
meta: {
count?: number | undefined;
};
}>, z.ZodArray<z.ZodAny, "many">]>>;
webResources: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
key: z.ZodString;
contexts: z.ZodArray<z.ZodString, "many">;
superbatch: z.ZodString;
uris: z.ZodRecord<z.ZodString, z.ZodString>;
tags: z.ZodArray<z.ZodString, "many">;
}, "strip", z.ZodTypeAny, {
key: string;
contexts: string[];
superbatch: string;
uris: Record<string, string>;
tags: string[];
}, {
key: string;
contexts: string[];
superbatch: string;
uris: Record<string, string>;
tags: string[];
}>, "many">;
meta: z.ZodObject<{
count: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
count?: number | undefined;
}, {
count?: number | undefined;
}>;
_links: z.ZodObject<{
self: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
next?: string | undefined;
self?: string | undefined;
}, {
next?: string | undefined;
self?: string | undefined;
}>;
}, "strip", z.ZodTypeAny, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
key: string;
contexts: string[];
superbatch: string;
uris: Record<string, string>;
tags: string[];
}[];
meta: {
count?: number | undefined;
};
}, {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
key: string;
contexts: string[];
superbatch: string;
uris: Record<string, string>;
tags: string[];
}[];
meta: {
count?: number | undefined;
};
}>, z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>]>>;
}, "strip", z.ZodTypeAny, {
title: string;
status: "current" | "archived" | "trashed" | "deleted" | "draft" | "historical";
id: string;
createdAt: string;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
};
spaceId: string;
authorId?: string | undefined;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
} | undefined;
labels?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
name: string;
prefix?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
operations?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
parentId?: string | null | undefined;
parentType?: string | null | undefined;
position?: number | null | undefined;
body?: {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
} | undefined;
parent?: {
title: string;
status: string;
id: string;
type: string;
} | undefined;
childTypes?: {
page?: boolean | undefined;
attachment?: boolean | undefined;
comment?: boolean | undefined;
} | undefined;
collaborators?: any[] | {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
collaboratorId: string;
businessObjectId: string;
appearanceId: string;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
webResources?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
key: string;
contexts: string[];
superbatch: string;
uris: Record<string, string>;
tags: string[];
}[];
meta: {
count?: number | undefined;
};
} | z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
}, {
title: string;
status: "current" | "archived" | "trashed" | "deleted" | "draft" | "historical";
id: string;
createdAt: string;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
};
spaceId: string;
authorId?: string | undefined;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
} | undefined;
labels?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
id: string;
name: string;
prefix?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
operations?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
targetType: string;
key?: string | undefined;
target?: string | undefined;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
parentId?: string | null | undefined;
parentType?: string | null | undefined;
position?: number | null | undefined;
body?: {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
} | undefined;
parent?: {
title: string;
status: string;
id: string;
type: string;
} | undefined;
childTypes?: {
page?: boolean | undefined;
attachment?: boolean | undefined;
comment?: boolean | undefined;
} | undefined;
collaborators?: any[] | {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
collaboratorId: string;
businessObjectId: string;
appearanceId: string;
}[];
meta: {
count?: number | undefined;
};
} | undefined;
webResources?: {
_links: {
next?: string | undefined;
self?: string | undefined;
};
results: {
key: string;
contexts: string[];
superbatch: string;
uris: Record<string, string>;
tags: string[];
}[];
meta: {
count?: number | undefined;
};
} | z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
}>;
/**
* Pages response schema
*/
export declare const PagesResponseSchema: z.ZodObject<{
results: z.ZodArray<z.ZodObject<{
id: z.ZodString;
status: z.ZodEnum<["current", "deleted", "historical", "trashed", "archived", "draft"]>;
title: z.ZodString;
spaceId: z.ZodString;
parentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
parentType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
authorId: z.ZodOptional<z.ZodString>;
createdAt: z.ZodString;
position: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
version: z.ZodOptional<z.ZodObject<{
number: z.ZodNumber;
message: z.ZodOptional<z.ZodString>;
minorEdit: z.ZodOptional<z.ZodBoolean>;
authorId: z.ZodOptional<z.ZodString>;
createdAt: z.ZodOptional<z.ZodString>;
contentTypeModifiedAt: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
}, {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
}>>;
_links: z.ZodObject<{
webui: z.ZodOptional<z.ZodString>;
editui: z.ZodOptional<z.ZodString>;
tinyui: z.ZodOptional<z.ZodString>;
base: z.ZodOptional<z.ZodString>;
next: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
}, {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
}>;
body: z.ZodOptional<z.ZodObject<{
storage: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
export_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
styled_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
atlas_doc_format: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
wiki: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
anonymous_export_view: z.ZodOptional<z.ZodObject<{
representation: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
representation: string;
}, {
value: string;
representation: string;
}>>;
}, "strip", z.ZodTypeAny, {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
}, {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
title: string;
status: "current" | "archived" | "trashed" | "deleted" | "draft" | "historical";
id: string;
createdAt: string;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
};
spaceId: string;
authorId?: string | undefined;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
} | undefined;
parentId?: string | null | undefined;
parentType?: string | null | undefined;
position?: number | null | undefined;
body?: {
view?: {
value: string;
representation: string;
} | undefined;
storage?: {
value: string;
representation: string;
} | undefined;
atlas_doc_format?: {
value: string;
representation: string;
} | undefined;
export_view?: {
value: string;
representation: string;
} | undefined;
anonymous_export_view?: {
value: string;
representation: string;
} | undefined;
styled_view?: {
value: string;
representation: string;
} | undefined;
wiki?: {
value: string;
representation: string;
} | undefined;
} | undefined;
}, {
title: string;
status: "current" | "archived" | "trashed" | "deleted" | "draft" | "historical";
id: string;
createdAt: string;
_links: {
webui?: string | undefined;
base?: string | undefined;
next?: string | undefined;
editui?: string | undefined;
tinyui?: string | undefined;
};
spaceId: string;
authorId?: string | undefined;
version?: {
number: number;
message?: string | undefined;
minorEdit?: boolean | undefined;
authorId?: string | undefined;
createdAt?: string | undefined;
contentTypeModifiedAt?: string | undefined;
} | undefined;
parentId?: string | null | undefined;
parentType?: string | null | undefined;
position?: number | null | undefined;
body?: {
v