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: string,
        ids: string[],
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws

• createCollection: function

  • createCollection(
        name?: string,
        ids?: string[],
        parentId?: string,
        isLocked?: boolean,
        options?: RawAxiosRequestConfig,
    ): 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>,
    >

    Throws

• removeFromCollection: function

  • removeFromCollection(
        collectionId: string,
        ids: string[],
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws