Function CollectionApiFp

Returns {
    acceptInvitation(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AcceptInvitation200Response>,
    >;
    changeCollaboratorAccessLevel(
        userId: number,
        id: number,
        changeCollaboratorAccessLevelRequest?: ChangeCollaboratorAccessLevelRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    createCollection(
        createCollectionRequest?: CreateCollectionRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateCollectionResponse>,
    >;
    deleteCollaborator(
        userId: number,
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >;
    emptyTrash(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >;
    getChildCollections(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetChildCollectionsResponse>,
    >;
    getCollaborators(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    getCollection(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCollectionResponse>,
    >;
    getFeaturedCovers(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeaturedCoversResponse>,
    >;
    getRootCollections(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRootCollectionsResponse>,
    >;
    getSystemCollectionStats(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSystemCollectionStatsResponse>,
    >;
    mergeCollections(
        mergeCollectionsRequest?: MergeCollectionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MergeCollectionsResponse>,
    >;
    removeAllEmptyCollections(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoveAllEmptyCollectionsResponse>,
    >;
    removeCollection(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >;
    removeCollections(
        removeCollectionsRequest?: RemoveCollectionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoveCollectionsResponse>,
    >;
    reorderAllCollections(
        reorderAllCollectionsRequest?: ReorderAllCollectionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >;
    searchCovers(
        text: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchCoversResponse>,
    >;
    shareCollection(
        id: number,
        shareCollectionRequest?: ShareCollectionRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShareCollectionResponse>,
    >;
    unshareOrLeaveCollection(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >;
    updateCollection(
        id: number,
        updateCollectionRequest?: UpdateCollectionRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateCollectionResponse>,
    >;
    uploadCollectionCover(
        id: number,
        cover?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UploadCollectionCoverResponse>,
    >;
}

• acceptInvitation: function

  • acceptInvitation(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AcceptInvitation200Response>,
    >

    Parameters

    • id: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• changeCollaboratorAccessLevel: function

  • changeCollaboratorAccessLevel(
        userId: number,
        id: number,
        changeCollaboratorAccessLevelRequest?: ChangeCollaboratorAccessLevelRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • userId: number
    • id: number
    • OptionalchangeCollaboratorAccessLevelRequest: ChangeCollaboratorAccessLevelRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createCollection: function

  • createCollection(
        createCollectionRequest?: CreateCollectionRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateCollectionResponse>,
    >

    Parameters

    • OptionalcreateCollectionRequest: CreateCollectionRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• deleteCollaborator: function

  • deleteCollaborator(
        userId: number,
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >

    Parameters

    • userId: number
    • id: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• emptyTrash: function

  • emptyTrash(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getChildCollections: function

  • getChildCollections(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetChildCollectionsResponse>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getCollaborators: function

  • getCollaborators(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • id: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getCollection: function

  • getCollection(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetCollectionResponse>,
    >

    Parameters

    • id: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getFeaturedCovers: function

  • getFeaturedCovers(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeaturedCoversResponse>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getRootCollections: function

  • getRootCollections(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRootCollectionsResponse>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getSystemCollectionStats: function

  • getSystemCollectionStats(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSystemCollectionStatsResponse>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• mergeCollections: function

  • mergeCollections(
        mergeCollectionsRequest?: MergeCollectionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MergeCollectionsResponse>,
    >

    Parameters

    • OptionalmergeCollectionsRequest: MergeCollectionsRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• removeAllEmptyCollections: function

  • removeAllEmptyCollections(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoveAllEmptyCollectionsResponse>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• removeCollection: function

  • removeCollection(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >

    Parameters

    • id: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• removeCollections: function

  • removeCollections(
        removeCollectionsRequest?: RemoveCollectionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RemoveCollectionsResponse>,
    >

    Parameters

    • OptionalremoveCollectionsRequest: RemoveCollectionsRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• reorderAllCollections: function

  • reorderAllCollections(
        reorderAllCollectionsRequest?: ReorderAllCollectionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >

    Parameters

    • OptionalreorderAllCollectionsRequest: ReorderAllCollectionsRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• searchCovers: function

  • searchCovers(
        text: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchCoversResponse>,
    >

    Parameters

    • text: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• shareCollection: function

  • shareCollection(
        id: number,
        shareCollectionRequest?: ShareCollectionRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShareCollectionResponse>,
    >

    Parameters

    • id: number
    • OptionalshareCollectionRequest: ShareCollectionRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• unshareOrLeaveCollection: function

  • unshareOrLeaveCollection(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SimpleResponse>,
    >

    Parameters

    • id: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateCollection: function

  • updateCollection(
        id: number,
        updateCollectionRequest?: UpdateCollectionRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateCollectionResponse>,
    >

    Parameters

    • id: number
    • OptionalupdateCollectionRequest: UpdateCollectionRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• uploadCollectionCover: function

  • uploadCollectionCover(
        id: number,
        cover?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UploadCollectionCoverResponse>,
    >

    Parameters

    • id: number
    • Optionalcover: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws