@dasch-swiss/dsp-js/src/api/admin/lists/lists-endpoint-admin.d.ts

JavaScript library that handles API requests to Knora

import { ChildNodeInfoResponse } from "../../../models/admin/child-node-info-response";
import { CreateChildNodeRequest } from "../../../models/admin/create-child-node-request";
import { CreateListRequest } from "../../../models/admin/create-list-request";
import { DeleteChildNodeCommentsResponse } from "../../../models/admin/delete-child-node-comments-response";
import { DeleteListNodeResponse } from "../../../models/admin/delete-list-node-response";
import { DeleteListResponse } from "../../../models/admin/delete-list-response";
import { ListChildNodeResponse } from "../../../models/admin/list-child-node-response";
import { ListInfoResponse } from "../../../models/admin/list-info-response";
import { ListNodeInfoResponse } from "../../../models/admin/list-node-info-response";
import { ListResponse } from "../../../models/admin/list-response";
import { ListsResponse } from "../../../models/admin/lists-response";
import { RepositionChildNodeRequest } from "../../../models/admin/reposition-child-node-request";
import { RepositionChildNodeResponse } from "../../../models/admin/reposition-child-node-response";
import { UpdateChildNodeCommentsRequest } from "../../../models/admin/update-child-node-comments-request";
import { UpdateChildNodeLabelsRequest } from "../../../models/admin/update-child-node-labels-request";
import { UpdateChildNodeNameRequest } from "../../../models/admin/update-child-node-name-request";
import { UpdateChildNodeRequest } from "../../../models/admin/update-child-node-request";
import { UpdateListInfoRequest } from "../../../models/admin/update-list-info-request";
import { ApiResponseData } from "../../../models/api-response-data";
import { Endpoint } from "../../endpoint";
/**
 * An endpoint for working with Knora lists.
 * @deprecated Use open API docs instead
 * @category Endpoint Admin
 */
export declare class ListsEndpointAdmin extends Endpoint {
    /**
     * Returns a list of lists.
     */
    getLists(): import("rxjs").Observable<ApiResponseData<ListsResponse>>;
    /**
     * Returns a list of lists in a project.
     *
     * @param projectIri The IRI of the project.
     */
    getListsInProject(projectIri: string): import("rxjs").Observable<ApiResponseData<ListsResponse>>;
    /**
     * Updates information about a list.
     *
     * @param listInfo Information about the list to be created.
     */
    updateListInfo(listInfo: UpdateListInfoRequest): import("rxjs").Observable<ApiResponseData<ListInfoResponse>>;
    /**
     * Updates the name of an existing child node.
     *
     * @param listItemIri the Iri of the list item.
     * @param name the new name to replace the existing name.
     */
    updateChildName(listItemIri: string, name: UpdateChildNodeNameRequest): import("rxjs").Observable<ApiResponseData<ChildNodeInfoResponse>>;
    /**
     * Updates the labels of an existing child node.
     *
     * @param listItemIri the Iri of the list item.
     * @param labels the new labels to replace the existing labels.
     */
    updateChildLabels(listItemIri: string, labels: UpdateChildNodeLabelsRequest): import("rxjs").Observable<ApiResponseData<ChildNodeInfoResponse>>;
    /**
     * Updates the comments of an existing child node.
     *
     * @param listItemIri the Iri of the list item.
     * @param comments the new comments to replace the existing comments.
     */
    updateChildComments(listItemIri: string, comments: UpdateChildNodeCommentsRequest): import("rxjs").Observable<ApiResponseData<ChildNodeInfoResponse>>;
    /**
     * Deletes the comments of an existing child node.
     *
     * @param listItemIri the Iri of the list item.
     */
    deleteChildComments(listItemIri: string): import("rxjs").Observable<ApiResponseData<DeleteChildNodeCommentsResponse>>;
    /**
     * Creates a child node in a list.
     *
     * @param node The node to be created.
     */
    createChildNode(node: CreateChildNodeRequest): import("rxjs").Observable<ApiResponseData<ListNodeInfoResponse>>;
    /**
     * Returns information about a list.
     *
     * @param iri The IRI of the list.
     */
    getListInfo(iri: string): import("rxjs").Observable<ApiResponseData<ListInfoResponse>>;
    /**
     * Returns the parent node if an IRI of a child node is given.
     * Returns a deleted flag and IRI if an IRI of a root node is given.
     *
     * @param iri The IRI of the list.
     */
    deleteListNode(iri: string): import("rxjs").Observable<ApiResponseData<DeleteListNodeResponse> | ApiResponseData<DeleteListResponse>>;
    /**
     * Move child node to a certain position in a list.
     * Parent node IRI can be the same but only if the position is different.
     *
     * @param iri The IRI of the list node to move.
     * @param repositionRequest The parent node IRI and the position the child node should move to.
     */
    repositionChildNode(iri: string, repositionRequest: RepositionChildNodeRequest): import("rxjs").Observable<ApiResponseData<RepositionChildNodeResponse>>;
    /**
     * Updates a child node.
     *
     * @param nodeInfo Information about the node to be updated.
     */
    updateChildNode(nodeInfo: UpdateChildNodeRequest): import("rxjs").Observable<ApiResponseData<ChildNodeInfoResponse>>;
    /**
     * Returns information about a list node using the new route.
     *
     * @param listItemIri The IRI of the node.
     */
    getListNodeInfo(listItemIri: string): import("rxjs").Observable<ApiResponseData<ListInfoResponse> | ApiResponseData<ListNodeInfoResponse>>;
    /**
     * Creates a list using the old route but with the feature toggle enabled.
     *
     * @param listInfo Information about the list to be created.
     */
    createList(listInfo: CreateListRequest): import("rxjs").Observable<ApiResponseData<ListResponse>>;
    /**
     * Gets a list using the old route but with the feature toggle enabled
     *
     * @param listItemIri The IRI of the list.
     */
    getList(listItemIri: string): import("rxjs").Observable<ApiResponseData<ListResponse> | ApiResponseData<ListChildNodeResponse>>;
}