Function CollectionApiFp

Returns {
    addToCollection(collectionId: string, ids: string[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    createCollection(name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollectionCreationResult>)>;
    removeFromCollection(collectionId: string, ids: string[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
}

• addToCollection:function

  • addToCollection(collectionId, ids, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • collectionId: string

      The collection id.
    • ids: string[]

      Item ids, comma delimited.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Adds items to a collection.

    Throws

• createCollection:function

  • createCollection(name?, ids?, parentId?, isLocked?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollectionCreationResult>)>

  • Parameters

    • 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.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollectionCreationResult>)>

    Summary

    Creates a new collection.

    Throws

• removeFromCollection:function

  • removeFromCollection(collectionId, ids, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • collectionId: string

      The collection id.
    • ids: string[]

      Item ids, comma delimited.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Removes items from a collection.

    Throws