Function CollectionApiFactory

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

• acceptInvitation: function

  • acceptInvitation(
        id: number,
        options?: any,
    ): AxiosPromise<AcceptInvitation200Response>

    Parameters

    • id: number
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<AcceptInvitation200Response>

    Throws

• changeCollaboratorAccessLevel: function

  • changeCollaboratorAccessLevel(
        userId: number,
        id: number,
        changeCollaboratorAccessLevelRequest?: ChangeCollaboratorAccessLevelRequest,
        options?: any,
    ): AxiosPromise<void>

    Parameters

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

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• createCollection: function

  • createCollection(
        createCollectionRequest?: CreateCollectionRequest,
        options?: any,
    ): AxiosPromise<CreateCollectionResponse>

    Parameters

    • OptionalcreateCollectionRequest: CreateCollectionRequest
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<CreateCollectionResponse>

    Throws

• deleteCollaborator: function

  • deleteCollaborator(
        userId: number,
        id: number,
        options?: any,
    ): AxiosPromise<SimpleResponse>

    Parameters

    • userId: number
    • id: number
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<SimpleResponse>

    Throws

• emptyTrash: function

  • emptyTrash(options?: any): AxiosPromise<SimpleResponse>

    Parameters

    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<SimpleResponse>

    Throws

• getChildCollections: function

  • getChildCollections(options?: any): AxiosPromise<GetChildCollectionsResponse>

    Parameters

    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<GetChildCollectionsResponse>

    Throws

• getCollaborators: function

  • getCollaborators(id: number, options?: any): AxiosPromise<void>

    Parameters

    • id: number
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• getCollection: function

  • getCollection(id: number, options?: any): AxiosPromise<GetCollectionResponse>

    Parameters

    • id: number
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<GetCollectionResponse>

    Throws

• getFeaturedCovers: function

  • getFeaturedCovers(options?: any): AxiosPromise<GetFeaturedCoversResponse>

    Parameters

    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<GetFeaturedCoversResponse>

    Throws

• getRootCollections: function

  • getRootCollections(options?: any): AxiosPromise<GetRootCollectionsResponse>

    Parameters

    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<GetRootCollectionsResponse>

    Throws

• getSystemCollectionStats: function

  • getSystemCollectionStats(
        options?: any,
    ): AxiosPromise<GetSystemCollectionStatsResponse>

    Parameters

    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<GetSystemCollectionStatsResponse>

    Throws

• mergeCollections: function

  • mergeCollections(
        mergeCollectionsRequest?: MergeCollectionsRequest,
        options?: any,
    ): AxiosPromise<MergeCollectionsResponse>

    Parameters

    • OptionalmergeCollectionsRequest: MergeCollectionsRequest
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<MergeCollectionsResponse>

    Throws

• removeAllEmptyCollections: function

  • removeAllEmptyCollections(
        options?: any,
    ): AxiosPromise<RemoveAllEmptyCollectionsResponse>

    Parameters

    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<RemoveAllEmptyCollectionsResponse>

    Throws

• removeCollection: function

  • removeCollection(id: number, options?: any): AxiosPromise<SimpleResponse>

    Parameters

    • id: number
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<SimpleResponse>

    Throws

• removeCollections: function

  • removeCollections(
        removeCollectionsRequest?: RemoveCollectionsRequest,
        options?: any,
    ): AxiosPromise<RemoveCollectionsResponse>

    Parameters

    • OptionalremoveCollectionsRequest: RemoveCollectionsRequest
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<RemoveCollectionsResponse>

    Throws

• reorderAllCollections: function

  • reorderAllCollections(
        reorderAllCollectionsRequest?: ReorderAllCollectionsRequest,
        options?: any,
    ): AxiosPromise<SimpleResponse>

    Parameters

    • OptionalreorderAllCollectionsRequest: ReorderAllCollectionsRequest
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<SimpleResponse>

    Throws

• searchCovers: function

  • searchCovers(text: string, options?: any): AxiosPromise<SearchCoversResponse>

    Parameters

    • text: string
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<SearchCoversResponse>

    Throws

• shareCollection: function

  • shareCollection(
        id: number,
        shareCollectionRequest?: ShareCollectionRequest,
        options?: any,
    ): AxiosPromise<ShareCollectionResponse>

    Parameters

    • id: number
    • OptionalshareCollectionRequest: ShareCollectionRequest
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<ShareCollectionResponse>

    Throws

• unshareOrLeaveCollection: function

  • unshareOrLeaveCollection(
        id: number,
        options?: any,
    ): AxiosPromise<SimpleResponse>

    Parameters

    • id: number
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<SimpleResponse>

    Throws

• updateCollection: function

  • updateCollection(
        id: number,
        updateCollectionRequest?: UpdateCollectionRequest,
        options?: any,
    ): AxiosPromise<UpdateCollectionResponse>

    Parameters

    • id: number
    • OptionalupdateCollectionRequest: UpdateCollectionRequest
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<UpdateCollectionResponse>

    Throws

• uploadCollectionCover: function

  • uploadCollectionCover(
        id: number,
        cover?: File,
        options?: any,
    ): AxiosPromise<UploadCollectionCoverResponse>

    Parameters

    • id: number
    • Optionalcover: File
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<UploadCollectionCoverResponse>

    Throws