observation-js/dist/lib/species.d.ts

A fully-typed TypeScript client for the waarneming.nl API.

import type { ObservationClient } from '../core/client';
import type { Observation, Paginated, SpeciesData, SpeciesGroup, SpeciesGroupAttributes, SpeciesOccurrence, SpeciesSearchParams } from '../types';
export declare class Species {
    #private;
    /**
     * @internal
     */
    constructor(client: ObservationClient);
    /**
     * Retrieves a single species by its ID.
     * The name of the species will be returned in the language set on the client (default: 'en').
     * This is a public endpoint and does not require authentication.
     *
     * @param id The unique identifier of the species.
     * @returns A promise that resolves to the species object.
     * @throws {ApiError} If the request fails.
     */
    get(id: number): Promise<SpeciesData>;
    /**
     * Searches for species based on a query string and other filters.
     * This is a public endpoint and does not require authentication.
     *
     * @param params - The search parameters, including the search query and filters.
     * @returns A promise that resolves to a paginated list of matching species.
     * @throws {ApiError} If the request fails.
     */
    search(params?: SpeciesSearchParams): Promise<Paginated<SpeciesData>>;
    /**
     * Retrieves observations for a single species.
     * This is a public endpoint and does not require authentication.
     *
     * @param id The unique identifier of the species.
     * @param params - Optional query parameters to filter the observations.
     * @returns A promise that resolves to a paginated list of observations for the species.
     * @throws {ApiError} If the request fails.
     */
    getObservations(id: number, params?: Record<string, string | number>): Promise<Paginated<Observation>>;
    /**
     * Retrieves species occurrence data for a given set of species IDs at a specific location.
     * This is a public endpoint and does not require authentication.
     *
     * @param ids - An array of species IDs.
     * @param point - The location, formatted as a WKT point string (e.g., 'POINT(4.895168 52.370216)').
     * @returns A promise that resolves to a list of species occurrences.
     * @throws {ApiError} If the request fails.
     */
    getOccurrence(ids: number[], point: string): Promise<Paginated<SpeciesOccurrence>>;
    /**
     * Retrieves a list of all species groups.
     * The names of the groups will be returned in the language set on the client (default: 'en').
     * This is a public endpoint and does not require authentication.
     *
     * @returns A promise that resolves to a list of species group objects.
     * @throws {ApiError} If the request fails.
     */
    listGroups(): Promise<SpeciesGroup[]>;
    /**
     * Retrieves detailed information about a species including descriptions, images, and other content.
     * This is a public endpoint and does not require authentication.
     *
     * @param id The unique identifier of the species.
     * @param coordinates Optional GPS coordinates as a string (e.g., "4.895168,52.370216").
     * @returns A promise that resolves to detailed species information.
     * @throws {ApiError} If the request fails.
     */
    getInformation(id: number, coordinates?: string): Promise<unknown>;
    /**
     * Retrieves all possible attribute values for observations across all species groups.
     * This is a public endpoint and does not require authentication.
     *
     * @returns A promise that resolves to the general attributes for all species groups.
     * @throws {ApiError} If the request fails.
     */
    getAllGroupAttributes(): Promise<SpeciesGroupAttributes>;
    /**
     * Retrieves the specific observation field attributes for a given species group.
     * This is a public endpoint and does not require authentication.
     *
     * @param id The unique identifier of the species group.
     * @returns A promise that resolves to the attributes for the species group.
     * @throws {ApiError} If the request fails.
     */
    getGroupAttributes(id: number): Promise<SpeciesGroupAttributes>;
}