mobility-toolbox-js/api/MocoAPI.d.ts

Toolbox for JavaScript applications in the domains of mobility and logistics.

import HttpAPI from './HttpAPI';
import type { MocoExportByIdParameters, MocoExportParameters } from '../types';
import type { SituationType, SituationTypeExtendedOffsetPaginated } from '../types';
export interface MocoAPIOptions {
    apiKey: string;
    graph?: string;
    tenant?: string;
    url?: string;
}
/**
 * This class provides convenience methods to use to the [geOps MOCO API](https://geops.com/de/solution/disruption-information).
 *
 * @example
 * import { MocoAPI } from 'mobility-toolbox-js/api';
 *
 * const api = new MocoAPI({
 *   // url: 'https://moco.geops.io/api/v2/',
 *   // tenant: "geopstest",
 * });
 *
 * const notifications = await api.export();
 *
 * console.log('Log route:', JSON.stringify(notifications));
 *
 * @private
 */
declare class MocoAPI extends HttpAPI {
    tenant: string;
    /**
     * Constructor
     *
     * @param {Object} options Options.
     *
     * @param {string} options.apiKey Access key for [geOps APIs](https://developer.geops.io/).
     * @param {string} [options.url='https://moco.geops.io/api/v2/'] Service url.
     * @param {string} [options.tenant='geopstest'] SSO config to get notifications from.
     */
    constructor(options: MocoAPIOptions);
    /**
     * Get paginated situations.
     */
    export(params?: MocoExportParameters, config?: RequestInit): Promise<{
        paginatedSituations: SituationTypeExtendedOffsetPaginated;
    }>;
    /**
     * Get a situation. Not all parameters are
     * relevant, only the text related are useful
     * (contentXXX, de, fr, it, en, includeXXX).
     */
    exportById(id: string, params?: MocoExportByIdParameters, config?: RequestInit): Promise<SituationType>;
}
export default MocoAPI;