Type Alias CreateCollectionData

type CreateCollectionData = {
    body?: never;
    path?: never;
    query?: {
        name?: string;
        ids?: string[];
        parentId?: string;
        isLocked?: boolean;
    };
    url: "/Collections";
}

Index

Properties

body? path? query? url

Properties

`Optional`body

body?: never

`Optional`path

path?: never

`Optional`query

query?: { name?: string; ids?: string[]; parentId?: string; isLocked?: boolean }

Type Declaration

Optionalname?: string

The name of the collection.
Optionalids?: string[]

Item Ids to add to the collection.
OptionalparentId?: string

Optional. Create the collection within a specific folder.
OptionalisLocked?: boolean

Whether or not to lock the new collection.

url

url: "/Collections"