Interface WordpressNodeParameters

Source
interface WordpressNodeParameters {
    additionalFields?:
        | {
            authorId?: string;
            categories?: unknown[];
            commentStatus?: "open"
            | "closed";
            content?: string;
            date?: string;
            format?:
                | "video"
                | "image"
                | "standard"
                | "status"
                | "link"
                | "audio"
                | "chat"
                | "quote"
                | "aside"
                | "gallery";
            password?: string;
            pingStatus?: "open"
            | "closed";
            postTemplate?: {
                values: {
                    elementor?: boolean;
                    template?: string;
                };
            };
            slug?: string;
            status?: | "private"
            | "publish"
            | "pending"
            | "draft"
            | "future";
            sticky?: boolean;
            tags?: unknown[];
        }
        | {
            authorId?: string;
            commentStatus?: "open"
            | "closed";
            content?: string;
            featuredMediaId?: number;
            menuOrder?: number;
            pageTemplate?: {
                values: {
                    elementor?: boolean;
                    template?: string;
                };
            };
            parent?: number;
            password?: string;
            pingStatus?: "open"
            | "closed";
            slug?: string;
            status?:
                | "private"
                | "publish"
                | "pending"
                | "draft"
                | "future";
        }
        | {
            description?: string;
            nickname?: string;
            slug?: string;
            url?: string;
        };
    email?: string;
    firstName?: string;
    lastName?: string;
    limit?: number;
    name?: string;
    operation?: "create"
    | "get"
    | "getAll"
    | "update";
    options?:
        | {
            context?: "edit"
            | "view"
            | "embed";
            password?: string;
        }
        | {
            after?: string;
            author?: unknown[];
            before?: string;
            categories?: unknown[];
            context?: "edit"
            | "view"
            | "embed";
            excludedCategories?: unknown[];
            excludedTags?: unknown[];
            order?: "asc" | "desc";
            orderBy?:
                | "id"
                | "relevance"
                | "date"
                | "author"
                | "parent"
                | "slug"
                | "title"
                | "include"
                | "include_slugs"
                | "modified";
            search?: string;
            status?: | "private"
            | "publish"
            | "pending"
            | "draft"
            | "future";
            sticky?: boolean;
            tags?: unknown[];
        }
        | { force?: boolean }
        | {
            after?: string;
            author?: unknown[];
            before?: string;
            context?: "edit" | "view" | "embed";
            menuOrder?: number;
            order?: "asc" | "desc";
            orderBy?:
                | "id"
                | "relevance"
                | "date"
                | "author"
                | "parent"
                | "slug"
                | "title"
                | "include"
                | "include_slugs"
                | "modified";
            page?: number;
            parent?: number;
            search?: string;
            status?: | "private"
            | "publish"
            | "pending"
            | "draft"
            | "future";
        }
        | { context?: "edit"
        | "view"
        | "embed" }
        | {
            context?: "edit" | "view" | "embed";
            order?: "asc" | "desc";
            orderBy?:
                | "id"
                | "url"
                | "email"
                | "name"
                | "slug"
                | "include"
                | "registered_date"
                | "include_slugs";
            search?: string;
            who?: "authors";
        };
    pageId?: string;
    password?: string;
    postId?: string;
    reassign?: string;
    resource?: "page"
    | "user"
    | "post";
    returnAll?: boolean;
    title?: string;
    updateFields?:
        | {
            authorId?: string;
            categories?: unknown[];
            commentStatus?: "open"
            | "closed";
            content?: string;
            date?: string;
            format?:
                | "video"
                | "image"
                | "standard"
                | "status"
                | "link"
                | "audio"
                | "chat"
                | "quote"
                | "aside"
                | "gallery";
            password?: string;
            pingStatus?: "open"
            | "closed";
            postTemplate?: {
                values: {
                    elementor?: boolean;
                    template?: string;
                };
            };
            slug?: string;
            status?: | "private"
            | "publish"
            | "pending"
            | "draft"
            | "future";
            sticky?: boolean;
            tags?: unknown[];
            title?: string;
        }
        | {
            authorId?: string;
            commentStatus?: "open"
            | "closed";
            content?: string;
            featuredMediaId?: number;
            menuOrder?: number;
            pageTemplate?: {
                values: {
                    elementor?: boolean;
                    template?: string;
                };
            };
            parent?: number;
            password?: string;
            pingStatus?: "open"
            | "closed";
            slug?: string;
            status?:
                | "private"
                | "publish"
                | "pending"
                | "draft"
                | "future";
            title?: string;
        }
        | {
            description?: string;
            email?: string;
            firstName?: string;
            lastName?: string;
            name?: string;
            nickname?: string;
            password?: string;
            slug?: string;
            url?: string;
            username?: string;
        };
    userId?: string;
    username?: string;
}

Properties§

Source§

readonly additionalFields?:
    | {
        authorId?: string;
        categories?: unknown[];
        commentStatus?: "open"
        | "closed";
        content?: string;
        date?: string;
        format?:
            | "video"
            | "image"
            | "standard"
            | "status"
            | "link"
            | "audio"
            | "chat"
            | "quote"
            | "aside"
            | "gallery";
        password?: string;
        pingStatus?: "open"
        | "closed";
        postTemplate?: {
            values: { elementor?: boolean; template?: string };
        };
        slug?: string;
        status?: | "private"
        | "publish"
        | "pending"
        | "draft"
        | "future";
        sticky?: boolean;
        tags?: unknown[];
    }
    | {
        authorId?: string;
        commentStatus?: "open"
        | "closed";
        content?: string;
        featuredMediaId?: number;
        menuOrder?: number;
        pageTemplate?: {
            values: { elementor?: boolean; template?: string };
        };
        parent?: number;
        password?: string;
        pingStatus?: "open"
        | "closed";
        slug?: string;
        status?:
            | "private"
            | "publish"
            | "pending"
            | "draft"
            | "future";
    }
    | {
        description?: string;
        nickname?: string;
        slug?: string;
        url?: string;
    }

Default: {}

Source§

readonly email?: string

The email address for the user

Source§

readonly firstName?: string

First name for the user

Source§

readonly lastName?: string

Last name for the user

Source§

readonly limit?: number

Max number of results to return Default: 5 Type options: {"minValue":1,"maxValue":10}

Source§

readonly name?: string

Display name for the user

Source§

readonly operation?: "create" | "get" | "getAll" | "update"

Default: "create"

Source§

readonly options?:
    | {
        context?: "edit"
        | "view"
        | "embed";
        password?: string;
    }
    | {
        after?: string;
        author?: unknown[];
        before?: string;
        categories?: unknown[];
        context?: "edit"
        | "view"
        | "embed";
        excludedCategories?: unknown[];
        excludedTags?: unknown[];
        order?: "asc" | "desc";
        orderBy?:
            | "id"
            | "relevance"
            | "date"
            | "author"
            | "parent"
            | "slug"
            | "title"
            | "include"
            | "include_slugs"
            | "modified";
        search?: string;
        status?: | "private"
        | "publish"
        | "pending"
        | "draft"
        | "future";
        sticky?: boolean;
        tags?: unknown[];
    }
    | { force?: boolean }
    | {
        after?: string;
        author?: unknown[];
        before?: string;
        context?: "edit" | "view" | "embed";
        menuOrder?: number;
        order?: "asc" | "desc";
        orderBy?:
            | "id"
            | "relevance"
            | "date"
            | "author"
            | "parent"
            | "slug"
            | "title"
            | "include"
            | "include_slugs"
            | "modified";
        page?: number;
        parent?: number;
        search?: string;
        status?: | "private"
        | "publish"
        | "pending"
        | "draft"
        | "future";
    }
    | { context?: "edit"
    | "view"
    | "embed" }
    | {
        context?: "edit" | "view" | "embed";
        order?: "asc" | "desc";
        orderBy?:
            | "id"
            | "url"
            | "email"
            | "name"
            | "slug"
            | "include"
            | "registered_date"
            | "include_slugs";
        search?: string;
        who?: "authors";
    }

Default: {}

Source§

readonly pageId?: string

Unique identifier for the object

Source§

readonly password?: string

Password for the user (never included) Type options: {"password":true}

Source§

readonly postId?: string

Unique identifier for the object

Source§

readonly reassign?: string

Reassign the deleted user's posts and links to this user ID

Source§

readonly resource?: "page" | "user" | "post"

Default: "post"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly title?: string

The title for the post

Source§

readonly updateFields?:
    | {
        authorId?: string;
        categories?: unknown[];
        commentStatus?: "open"
        | "closed";
        content?: string;
        date?: string;
        format?:
            | "video"
            | "image"
            | "standard"
            | "status"
            | "link"
            | "audio"
            | "chat"
            | "quote"
            | "aside"
            | "gallery";
        password?: string;
        pingStatus?: "open"
        | "closed";
        postTemplate?: {
            values: { elementor?: boolean; template?: string };
        };
        slug?: string;
        status?: | "private"
        | "publish"
        | "pending"
        | "draft"
        | "future";
        sticky?: boolean;
        tags?: unknown[];
        title?: string;
    }
    | {
        authorId?: string;
        commentStatus?: "open"
        | "closed";
        content?: string;
        featuredMediaId?: number;
        menuOrder?: number;
        pageTemplate?: {
            values: { elementor?: boolean; template?: string };
        };
        parent?: number;
        password?: string;
        pingStatus?: "open"
        | "closed";
        slug?: string;
        status?:
            | "private"
            | "publish"
            | "pending"
            | "draft"
            | "future";
        title?: string;
    }
    | {
        description?: string;
        email?: string;
        firstName?: string;
        lastName?: string;
        name?: string;
        nickname?: string;
        password?: string;
        slug?: string;
        url?: string;
        username?: string;
    }

Default: {}

Source§

readonly userId?: string

Unique identifier for the user

Source§

readonly username?: string

Login name for the user