geonet/dist/src/services/NetworkService.d.ts

A Node.js API wrapper for GeoNet — Aotearoa's geological hazard monitoring system.

import { NetworkFDSNStationRequest, NetworkFDSNStationResponse, NetworkGNSStationResponse, NetworkSensorRequest, NetworkSensorResponse } from "../../@types/network";
import { BaseService } from "./BaseService";
/**
 * StrongService class for fetching strong motion information for a specified quake from the GeoNet API.
 * @extends BaseService
 * @since 1.0.0
 */
export declare class NetworkService extends BaseService {
    /**
     * Fetches network data for a given sensor type.
     *
     * @param {NetworkSensorRequest} req - The request object containing the sensor type.
     * @returns {Promise<NetworkSensorResponse>} - A promise that resolves to the sensor data.
     * @throws {Error} - Throws an error if the sensor type is not provided, or if the optional parameters are not strings.
     * @since 1.0.0
     */
    getNetworkSensor(req: NetworkSensorRequest): Promise<NetworkSensorResponse>;
    /**
     * Fetches network data for a specified GNSS mark.
     *
     * @param {string} code - The mark code.
     * @returns {Promise<NetworkGNSStationResponse>} - A promise that resolves to the sensor details data.
     * @throws {Error} - Throws an error if the mark code is not provided.
     * @since 1.0.0
     */
    getNetworkGNSSDetails(code: string): Promise<NetworkGNSStationResponse>;
    /**
     * Fetches network data for a specified GNSS mark.
     *
     * @param {NetworkFDSNStationRequest} req - The request object containing the mark code.
     * @returns {Promise<NetworkFDSNStationResponse>} - A promise that resolves to the sensor details data.
     * @throws {Error} - Throws an error if the mark code is not provided.
     * @since 1.0.0
     */
    getNetworkFDSNDetails(req: NetworkFDSNStationRequest): Promise<NetworkFDSNStationResponse>;
}