nodes/generated

Interface BoxNodeParameters

Source
interface BoxNodeParameters {
    accessibleBy?: "user" | "group";
    additionalFields?:
        | {
            fields?: string;
            name?: string;
            version?: string;
        }
        | { fields?: string }
        | {
            ancestor_folder_ids?: string;
            contet_types?: string;
            createdRangeUi?: {
                createdRangeValuesUi: {
                    from?: string;
                    to?: string;
                };
            };
            direction?: "ASC"
            | "DESC";
            fields?: string;
            file_extensions?: string;
            owner_user_ids?: string;
            scope?: "user_content" | "enterprise_content";
            size_range?: string;
            sort?: "relevance" | "modified_at";
            trash_content?: "non_trashed_only" | "trashed_only";
            updatedRangeUi?: {
                updatedRangeValuesUi: {
                    from?: string;
                    to?: string;
                };
            };
        };
    binaryData?: boolean;
    binaryPropertyName?: string;
    email?: string;
    fileContent?: string;
    fileId?: string;
    fileName?: string;
    folderId?: string;
    groupId?: string;
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "update"
    | "delete"
    | "search"
    | "upload"
    | "copy"
    | "download"
    | "share";
    options?: | {
        can_view_path?: boolean;
        expires_at?: string;
        fields?: string;
        notify?: boolean;
    }
    | {
        access?: "collaborators"
        | "open";
        fields?: string;
    };
    parentId?: string;
    query?: string;
    recursive?: boolean;
    resource?: "file"
    | "folder";
    returnAll?: boolean;
    role?:
        | "coOwner"
        | "editor"
        | "previewer"
        | "previewerUploader"
        | "uploader"
        | "viewer"
        | "viewerUploader";
    updateFields?: {
        can_non_owners_invite?: boolean;
        can_non_owners_view_collaborators?: boolean;
        description?: string;
        fields?: string;
        is_collaboration_restricted_to_enterprise?: boolean;
        name?: string;
        parentId?: string;
        shared_link?: {
            access?: "company"
            | "collaborators"
            | "open";
            password?: string;
            permissions?: {
                can_download?: boolean;
                unshared_at?: string;
                vanity_name?: string;
            };
            tags?: string;
        };
    };
    useEmail?: boolean;
    userId?: string;
}

Properties§

Source§

readonly accessibleBy?: "user" | "group"

The type of object the file will be shared with

Source§

readonly additionalFields?:
    | {
        fields?: string;
        name?: string;
        version?: string;
    }
    | { fields?: string }
    | {
        ancestor_folder_ids?: string;
        contet_types?: string;
        createdRangeUi?: {
            createdRangeValuesUi: {
                from?: string;
                to?: string;
            };
        };
        direction?: "ASC"
        | "DESC";
        fields?: string;
        file_extensions?: string;
        owner_user_ids?: string;
        scope?: "user_content" | "enterprise_content";
        size_range?: string;
        sort?: "relevance" | "modified_at";
        trash_content?: "non_trashed_only" | "trashed_only";
        updatedRangeUi?: {
            updatedRangeValuesUi: {
                from?: string;
                to?: string;
            };
        };
    }

Default: {}

Source§

readonly binaryData?: boolean

Whether the data to upload should be taken from binary field

Source§

readonly binaryPropertyName?: string

Default: "data"

Source§

readonly email?: string

The user's email address to share the file with

Source§

readonly fileContent?: string

The text content of the file

Source§

readonly fileId?: string

Source§

readonly fileName?: string

The name the file should be saved as

Source§

readonly folderId?: string

Source§

readonly groupId?: string

The group's ID to share the file with

Source§

readonly limit?: number

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

Source§

readonly name?: string

Folder's name

Source§

readonly operation?:
    | "create"
    | "get"
    | "update"
    | "delete"
    | "search"
    | "upload"
    | "copy"
    | "download"
    | "share"

Default: "upload"

Source§

readonly options?:
    | {
        can_view_path?: boolean;
        expires_at?: string;
        fields?: string;
        notify?: boolean;
    }
    | {
        access?: "collaborators"
        | "open";
        fields?: string;
    }

Default: {}

Source§

readonly parentId?: string

The ID of folder to copy the file to. If not defined will be copied to the root folder.

Source§

readonly query?: string

The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types.

Source§

readonly recursive?: boolean

Whether to delete a folder that is not empty by recursively deleting the folder and all of its content

Source§

readonly resource?: "file" | "folder"

Default: "file"

Source§

readonly returnAll?: boolean

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

Source§

readonly role?:
    | "coOwner"
    | "editor"
    | "previewer"
    | "previewerUploader"
    | "uploader"
    | "viewer"
    | "viewerUploader"

The level of access granted Default: "editor"

Source§

readonly updateFields?: {
    can_non_owners_invite?: boolean;
    can_non_owners_view_collaborators?: boolean;
    description?: string;
    fields?: string;
    is_collaboration_restricted_to_enterprise?: boolean;
    name?: string;
    parentId?: string;
    shared_link?: {
        access?: "company" | "collaborators" | "open";
        password?: string;
        permissions?: {
            can_download?: boolean;
            unshared_at?: string;
            vanity_name?: string;
        };
        tags?: string;
    };
}

Default: {}

Source§

readonly useEmail?: boolean

Whether identify the user by email or ID Default: true

Source§

readonly userId?: string

The user's ID to share the file with