@knora/api/src/api/v2/values/values-endpoint.d.ts

JavaScript library that handles API requests to Knora

import { Observable } from "rxjs";
import { KnoraApiConfig } from "../../../knora-api-config";
import { ApiResponseError } from "../../../models/api-response-error";
import { ReadResource } from "../../../models/v2/resources/read/read-resource";
import { UpdateResource } from "../../../models/v2/resources/update/update-resource";
import { CreateValue } from "../../../models/v2/resources/values/create/create-value";
import { DeleteValue } from "../../../models/v2/resources/values/delete/delete-value";
import { DeleteValueResponse } from "../../../models/v2/resources/values/delete/delete-value-response";
import { UpdateValue } from "../../../models/v2/resources/values/update/update-value";
import { WriteValueResponse } from "../../../models/v2/resources/values/write-value-response";
import { Endpoint } from "../../endpoint";
import { V2Endpoint } from "../v2-endpoint";
/**
 * Handles requests to the values route of the Knora API.
 */
export declare class ValuesEndpoint extends Endpoint {
    protected readonly knoraApiConfig: KnoraApiConfig;
    protected readonly path: string;
    private readonly v2Endpoint;
    constructor(knoraApiConfig: KnoraApiConfig, path: string, v2Endpoint: V2Endpoint);
    /**
     * Reads a value from Knora.
     *
     * @param resourceIri the Iri of the resource the value belongs to.
     * @param valueUuid the value's UUID.
     */
    getValue(resourceIri: string, valueUuid: string): Observable<ReadResource | ApiResponseError>;
    /**
     * Updates an existing value.
     *
     * @param resource The resource with the value to be updated.
     */
    updateValue(resource: UpdateResource<UpdateValue>): Observable<WriteValueResponse | ApiResponseError>;
    /**
     * Creates a new value.
     *
     * @param resource The resource with the value to be created.
     */
    createValue(resource: UpdateResource<CreateValue>): Observable<WriteValueResponse | ApiResponseError>;
    /**
     * Deletes a value.
     *
     * @param resource The resource with the value to be deleted.
     */
    deleteValue(resource: UpdateResource<DeleteValue>): Observable<DeleteValueResponse | ApiResponseError>;
}