golemio-sdk/dist/cjs/sdk-vp/api.d.ts

TypeScript SDK for api.golemio.cz

/**
 * 🚋 Public Transport | Golemio API
 * <p><img src=\"https://storage.golemio.cz/golemiocz/images/golemioapi_logos.png\" alt=\"Logos\" /></p> <p><b>Toto je část dokumentace REST API projektu pražské datové platformy Golemio, která obsahuje popis Public Transport Output Gateway API.</b></p> <p>Veškeré dotazy prosím směřujte na <a href=\"mailto:golemio@operatorict.cz?subject=golemioapi\">golemio@operatorict.cz</a>.</p> <p>Dokumentace je v anglickém jazyce. Více informací o projektu naleznete na <a href=\"https://www.golemio.cz/\">www.golemio.cz</a>.</p> <H1>Description</H1> <p><b>This documentation covers the RESTful API of the Golemio Prague Data Platform project, specifically detailing the Public Transport Output Gateway API.</b></p> <p>Support is accessible via <a href=\"mailto:golemio@operatorict.cz?subject=golemioapi\">golemio@operatorict.cz</a>.</p> <p>For more information about Golemio, please visit the website <a href=\"https://www.golemio.cz/\">www.golemio.cz</a>.</p> <H2>Golemio API documentation:</H2> <li><a href=\"https://api.golemio.cz/docs/openapi/\">Main Golemio API</a></li> <li><a href=\"https://api.golemio.cz/docs/public-openapi/\">Open Data Golemio API</a></li> <li><a href=\"https://api.golemio.cz/input-gateway/docs/openapi/\">Golemio Input Gateway API</a></li> <li>👉 Public Transport Golemio API</li> <li><a href=\"https://api.golemio.cz/pid/input-gateway/docs/openapi/\">Public Transport Golemio Input Gateway API</a></li> <H1>General info</H1> <H2>Authorization</H2> <p>Generate your token at <a href=\"https://api.golemio.cz/api-keys\">api.golemio.cz/api-keys</a>.</p> <p><b>Use the token as the value of the X-Access-Token header.</b></p> <H1>Usage</H1> <H2>Pagination</H2> <p>The API returns a maximum of 10,000 objects/rows per request. You can specify a lower number by adding the <code>?limit</code> URL parameter.</p> <p>     This limit may vary depending on the specific route; please refer to the description of parameters for each route. To retrieve more data, use multiple requests with the <code>?limit&offset</code> parameters.     Refer to the examples below. </p> <H2>Requests rate</H2> <p>By default, each API key has a rate limit of 20 requests per 8 seconds.</p> <H2>Compression</H2> <p>By default, the Content-Encoding header is set to gzip (if requested). If the raw response is less than 1 KB, the data is returned uncompressed, and the Content-Encoding header is not set.</p> <H2>General Transit Feed Specification</H2> <p>Access GTFS (<a href=\"https://developers.google.com/transit/gtfs\">General Transit Feed Specification</a>) data on the city\'s public transportation schedules through this API.</p> <p>The data is published by ROPID and remains valid for the upcoming ~12 days, subject to daily updates.</p> <p>Learn more at <a href=\"https://pid.cz/o-systemu/opendata/\">pid.cz</a>.</p> <H2>Open Data</H2> <p><img src=\"https://img.shields.io/badge/opendata-available-green\" alt=\"golemioapi-opendata-badge\" /></p> <p>This badge means it is available for public use as Open Data.</p>
 *
 * The version of the OpenAPI document: 1.0.0
 * Contact: golemio@operatorict.cz
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { ConfigurationParameters as GolemioPublicTransportApiConfiguration } from './configuration';
import type { AxiosInstance, AxiosRequestConfig } from 'axios';
import { BaseAPI } from './base';
export type { ConfigurationParameters as GolemioPublicTransportApiConfiguration } from './configuration';
export declare class GolemioPublicTransportApi {
    FYPRV1Api: GolemioPublicTransportApi.FYPRV1Api;
    GTFSRealtimeV2Api: GolemioPublicTransportApi.GTFSRealtimeV2Api;
    GTFSStaticV2Api: GolemioPublicTransportApi.GTFSStaticV2Api;
    JISV1InternalApi: GolemioPublicTransportApi.JISV1InternalApi;
    PIDDepartureBoardsV2Api: GolemioPublicTransportApi.PIDDepartureBoardsV2Api;
    PIDDepartureBoardsV3Api: GolemioPublicTransportApi.PIDDepartureBoardsV3Api;
    PIDDepartureBoardsV3InternalApi: GolemioPublicTransportApi.PIDDepartureBoardsV3InternalApi;
    PIDDepartureBoardsV4Api: GolemioPublicTransportApi.PIDDepartureBoardsV4Api;
    PIDRealtimePositionsV2Api: GolemioPublicTransportApi.PIDRealtimePositionsV2Api;
    PublicDeparturesV2Api: GolemioPublicTransportApi.PublicDeparturesV2Api;
    PublicGTFSStaticLookupV2Api: GolemioPublicTransportApi.PublicGTFSStaticLookupV2Api;
    PublicVehiclePositionsV2Api: GolemioPublicTransportApi.PublicVehiclePositionsV2Api;
    constructor(configurationParams: GolemioPublicTransportApiConfiguration, axios?: AxiosInstance);
}
export declare namespace GolemioPublicTransportApi {
    /**
 *
 * @export
 * @interface ASWid
 */
    interface ASWid {
        /**
         * ASW ID of node
         * @type {number}
         * @memberof ASWid
         */
        'node': number;
        /**
         * Identification of the stop within the node.
         * @type {number}
         * @memberof ASWid
         */
        'stop': number;
    }
    /**
 * Fully composed DisplayCase schema for list responses. Combines DisplayCaseBase (writable display-case-specific and base fields) with server-set read-only fields from ElementReadOnly. The required array enforces that id and source_updated_at are always present in responses.
 * @export
 * @interface DisplayCase
 */
    interface DisplayCase {
        /**
         * Server-generated UUID primary key. Immutable after creation.
         * @type {string}
         * @memberof DisplayCase
         */
        'id': string;
        /**
         * Timestamp when the record was first created in the upstream CMS (Strapi). ISO 8601 UTC. Server-set, not writable by clients.
         * @type {string}
         * @memberof DisplayCase
         */
        'source_created_at'?: string;
        /**
         * Timestamp of the most recent update in the upstream CMS (Strapi). ISO 8601 UTC. Server-set, not writable by clients.
         * @type {string}
         * @memberof DisplayCase
         */
        'source_updated_at': string;
        /**
         * Timestamp when the record was published in the upstream CMS (Strapi). ISO 8601 UTC. Server-set, not writable by clients.
         * @type {string}
         * @memberof DisplayCase
         */
        'source_published_at'?: string;
        /**
         * Unique document identifier sourced from the upstream CMS (Strapi). Used as the stable external reference for deduplication.
         * @type {string}
         * @memberof DisplayCase
         */
        'document_id': string;
        /**
         * Optional external UUID assigned to the physical element by the field operations team. May be null for elements not yet assigned.
         * @type {string}
         * @memberof DisplayCase
         */
        'uid'?: string | null;
        /**
         * Discriminator field identifying the element type. Determines which typed schema applies (Totem, InformationPanel, DisplayCase, Obelisk, Signpost).
         * @type {string}
         * @memberof DisplayCase
         */
        'kind': DisplayCaseKindEnum;
        /**
         * Human-readable name of the element. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'name'?: string | null;
        /**
         * Lifecycle state of the element (e.g. PLANNED, IN_PROGRESS, REALIZED). Sourced from CMS. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'state'?: string | null;
        /**
         * Organization or entity that owns the element. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'owner'?: string | null;
        /**
         * Organization or entity that manages the element. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'manager'?: string | null;
        /**
         * Prague city district where the element is physically located. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'city_district'?: string | null;
        /**
         * WGS-84 latitude coordinate of the element\'s installation site. May be null if coordinates are not yet surveyed.
         * @type {number}
         * @memberof DisplayCase
         */
        'lat'?: number | null;
        /**
         * WGS-84 longitude coordinate of the element\'s installation site. May be null if coordinates are not yet surveyed.
         * @type {number}
         * @memberof DisplayCase
         */
        'lon'?: number | null;
        /**
         * URL to an external map view showing the element location. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'map_link'?: string | null;
        /**
         * Year in which the element is planned to be realized or installed. Stored as string to accommodate partial or estimated values. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'planned_year_of_realization'?: string | null;
        /**
         * Free-text operational note attached to the element by field staff. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'note'?: string | null;
        /**
         * Indicates whether the element has been handed over to the maintenance team. May be null if handover status is unknown.
         * @type {boolean}
         * @memberof DisplayCase
         */
        'handover'?: boolean | null;
        /**
         * Date on which the element was formally handed over to the maintenance team. ISO 8601 date. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'handover_date'?: string | null;
        /**
         * Name of the public transport stop where the display case is installed. May be null if not yet associated with a stop.
         * @type {string}
         * @memberof DisplayCase
         */
        'stop_name'?: string | null;
        /**
         * Direction indicator for the stop (e.g. towards a terminal station). May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'stop_direction'?: string | null;
        /**
         * Platform or stand code at the stop where the display case is located. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'platform_code'?: string | null;
        /**
         * List of transport mode types served by the associated stop (e.g. bus, tram, metro). May be null if stop type is unknown.
         * @type {Array<string>}
         * @memberof DisplayCase
         */
        'stop_type'?: Array<string> | null;
        /**
         * Stop identifier from the THMP (Prague Transport Information System). May be null if not linked to a THMP stop.
         * @type {string}
         * @memberof DisplayCase
         */
        'thmp_stop_id'?: string | null;
        /**
         * Type classification of the shelter or enclosure housing the display case. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'shelter_type'?: string | null;
        /**
         * Identifier of the shelter unit that contains this display case. May be null if not housed in a tracked shelter.
         * @type {string}
         * @memberof DisplayCase
         */
        'shelter_id'?: string | null;
        /**
         * QR code value or URL associated with the display case for passenger information access. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'qr_code'?: string | null;
        /**
         * Name of the company or contractor that supplied or installed the display case. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'supplier'?: string | null;
        /**
         * Free-text operational comments or notes about the display case entered by field staff. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'comments'?: string | null;
        /**
         * Node identifier from the ASW (Automated Stop Management) system linking the display case to a stop node. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'asw_node_id'?: string | null;
        /**
         * Stop identifier from the ASW (Automated Stop Management) system. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'asw_stop_id'?: string | null;
        /**
         * Human-readable description of the exact physical placement of the display case at the stop. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'location_description'?: string | null;
        /**
         * Name of the street or square where the display case is located. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'street_name'?: string | null;
        /**
         * Element identifier assigned by ROPID (Prague Integrated Transport organizer). May be null if not yet registered with ROPID.
         * @type {string}
         * @memberof DisplayCase
         */
        'ropid_element_id'?: string | null;
        /**
         * Acquisition or installation price of the display case excluding VAT, in Czech crowns (CZK). May be null if cost data is unavailable.
         * @type {number}
         * @memberof DisplayCase
         */
        'price_without_vat'?: number | null;
        /**
         * Manufacturer serial number of the display case unit. Used for asset tracking and warranty management. May be null.
         * @type {string}
         * @memberof DisplayCase
         */
        'serial_number'?: string | null;
        /**
         * Element number assigned by the THMP (Prague Transport Information System). May be null if not registered in THMP.
         * @type {string}
         * @memberof DisplayCase
         */
        'thmp_element_number'?: string | null;
        /**
         * Scheduled cleaning frequency for the display case (e.g. daily, weekly, monthly). May be null if no cleaning schedule is set.
         * @type {string}
         * @memberof DisplayCase
         */
        'cleaning_frequency'?: string | null;
    }
    const DisplayCaseKindEnum: {
        readonly Totem: "totem";
        readonly InformationPanel: "information_panel";
        readonly DisplayCase: "display_case";
        readonly Obelisk: "obelisk";
        readonly Signpost: "signpost";
    };
    type DisplayCaseKindEnum = typeof DisplayCaseKindEnum[keyof typeof DisplayCaseKindEnum];
    /**
 *
 * @export
 * @interface DisplayCaseBase
 */
    interface DisplayCaseBase {
        /**
         * Unique document identifier sourced from the upstream CMS (Strapi). Used as the stable external reference for deduplication.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'document_id': string;
        /**
         * Optional external UUID assigned to the physical element by the field operations team. May be null for elements not yet assigned.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'uid'?: string | null;
        /**
         * Discriminator field identifying the element type. Determines which typed schema applies (Totem, InformationPanel, DisplayCase, Obelisk, Signpost).
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'kind': DisplayCaseBaseKindEnum;
        /**
         * Human-readable name of the element. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'name'?: string | null;
        /**
         * Lifecycle state of the element (e.g. PLANNED, IN_PROGRESS, REALIZED). Sourced from CMS. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'state'?: string | null;
        /**
         * Organization or entity that owns the element. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'owner'?: string | null;
        /**
         * Organization or entity that manages the element. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'manager'?: string | null;
        /**
         * Prague city district where the element is physically located. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'city_district'?: string | null;
        /**
         * WGS-84 latitude coordinate of the element\'s installation site. May be null if coordinates are not yet surveyed.
         * @type {number}
         * @memberof DisplayCaseBase
         */
        'lat'?: number | null;
        /**
         * WGS-84 longitude coordinate of the element\'s installation site. May be null if coordinates are not yet surveyed.
         * @type {number}
         * @memberof DisplayCaseBase
         */
        'lon'?: number | null;
        /**
         * URL to an external map view showing the element location. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'map_link'?: string | null;
        /**
         * Year in which the element is planned to be realized or installed. Stored as string to accommodate partial or estimated values. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'planned_year_of_realization'?: string | null;
        /**
         * Free-text operational note attached to the element by field staff. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'note'?: string | null;
        /**
         * Indicates whether the element has been handed over to the maintenance team. May be null if handover status is unknown.
         * @type {boolean}
         * @memberof DisplayCaseBase
         */
        'handover'?: boolean | null;
        /**
         * Date on which the element was formally handed over to the maintenance team. ISO 8601 date. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'handover_date'?: string | null;
        /**
         * Name of the public transport stop where the display case is installed. May be null if not yet associated with a stop.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'stop_name'?: string | null;
        /**
         * Direction indicator for the stop (e.g. towards a terminal station). May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'stop_direction'?: string | null;
        /**
         * Platform or stand code at the stop where the display case is located. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'platform_code'?: string | null;
        /**
         * List of transport mode types served by the associated stop (e.g. bus, tram, metro). May be null if stop type is unknown.
         * @type {Array<string>}
         * @memberof DisplayCaseBase
         */
        'stop_type'?: Array<string> | null;
        /**
         * Stop identifier from the THMP (Prague Transport Information System). May be null if not linked to a THMP stop.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'thmp_stop_id'?: string | null;
        /**
         * Type classification of the shelter or enclosure housing the display case. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'shelter_type'?: string | null;
        /**
         * Identifier of the shelter unit that contains this display case. May be null if not housed in a tracked shelter.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'shelter_id'?: string | null;
        /**
         * QR code value or URL associated with the display case for passenger information access. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'qr_code'?: string | null;
        /**
         * Name of the company or contractor that supplied or installed the display case. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'supplier'?: string | null;
        /**
         * Free-text operational comments or notes about the display case entered by field staff. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'comments'?: string | null;
        /**
         * Node identifier from the ASW (Automated Stop Management) system linking the display case to a stop node. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'asw_node_id'?: string | null;
        /**
         * Stop identifier from the ASW (Automated Stop Management) system. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'asw_stop_id'?: string | null;
        /**
         * Human-readable description of the exact physical placement of the display case at the stop. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'location_description'?: string | null;
        /**
         * Name of the street or square where the display case is located. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'street_name'?: string | null;
        /**
         * Element identifier assigned by ROPID (Prague Integrated Transport organizer). May be null if not yet registered with ROPID.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'ropid_element_id'?: string | null;
        /**
         * Acquisition or installation price of the display case excluding VAT, in Czech crowns (CZK). May be null if cost data is unavailable.
         * @type {number}
         * @memberof DisplayCaseBase
         */
        'price_without_vat'?: number | null;
        /**
         * Manufacturer serial number of the display case unit. Used for asset tracking and warranty management. May be null.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'serial_number'?: string | null;
        /**
         * Element number assigned by the THMP (Prague Transport Information System). May be null if not registered in THMP.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'thmp_element_number'?: string | null;
        /**
         * Scheduled cleaning frequency for the display case (e.g. daily, weekly, monthly). May be null if no cleaning schedule is set.
         * @type {string}
         * @memberof DisplayCaseBase
         */
        'cleaning_frequency'?: string | null;
    }
    const DisplayCaseBaseKindEnum: {
        readonly Totem: "totem";
        readonly InformationPanel: "information_panel";
        readonly DisplayCase: "display_case";
        readonly Obelisk: "obelisk";
        readonly Signpost: "signpost";
    };
    type DisplayCaseBaseKindEnum = typeof DisplayCaseBaseKindEnum[keyof typeof DisplayCaseBaseKindEnum];
    /**
 *
 * @export
 * @interface Effect
 */
    interface Effect {
        /**
         *
         * @type {string}
         * @memberof Effect
         */
        'cs': string;
        /**
         *
         * @type {string}
         * @memberof Effect
         */
        'en'?: string | null;
    }
    /**
 * Writable base fields shared by all FYPR element types. No id or timestamps. Composed via allOf by each typed element schema.
 * @export
 * @interface ElementBase
 */
    interface ElementBase {
        /**
         * Unique document identifier sourced from the upstream CMS (Strapi). Used as the stable external reference for deduplication.
         * @type {string}
         * @memberof ElementBase
         */
        'document_id': string;
        /**
         * Optional external UUID assigned to the physical element by the field operations team. May be null for elements not yet assigned.
         * @type {string}
         * @memberof ElementBase
         */
        'uid'?: string | null;
        /**
         * Discriminator field identifying the element type. Determines which typed schema applies (Totem, InformationPanel, DisplayCase, Obelisk, Signpost).
         * @type {string}
         * @memberof ElementBase
         */
        'kind': ElementBaseKindEnum;
        /**
         * Human-readable name of the element. May be null.
         * @type {string}
         * @memberof ElementBase
         */
        'name'?: string | null;
        /**
         * Lifecycle state of the element (e.g. PLANNED, IN_PROGRESS, REALIZED). Sourced from CMS. May be null.
         * @type {string}
         * @memberof ElementBase
         */
        'state'?: string | null;
        /**
         * Organization or entity that owns the element. May be null.
         * @type {string}
         * @memberof ElementBase
         */
        'owner'?: string | null;
        /**
         * Organization or entity that manages the element. May be null.
         * @type {string}
         * @memberof ElementBase
         */
        'manager'?: string | null;
        /**
         * Prague city district where the element is physically located. May be null.
         * @type {string}
         * @memberof ElementBase
         */
        'city_district'?: string | null;
        /**
         * WGS-84 latitude coordinate of the element\'s installation site. May be null if coordinates are not yet surveyed.
         * @type {number}
         * @memberof ElementBase
         */
        'lat'?: number | null;
        /**
         * WGS-84 longitude coordinate of the element\'s installation site. May be null if coordinates are not yet surveyed.
         * @type {number}
         * @memberof ElementBase
         */
        'lon'?: number | null;
        /**
         * URL to an external map view showing the element location. May be null.
         * @type {string}
         * @memberof ElementBase
         */
        'map_link'?: string | null;
        /**
         * Year in which the element is planned to be realized or installed. Stored as string to accommodate partial or estimated values. May be null.
         * @type {string}
         * @memberof ElementBase
         */
        'planned_year_of_realization'?: string | null;
        /**
         * Free-text operational note attached to the element by field staff. May be null.
         * @type {string}
         * @memberof ElementBase
         */
        'note'?: string | null;
        /**
         * Indicates whether the element has been handed over to the maintenance team. May be null if handover status is unknown.
         * @type {boolean}
         * @memberof ElementBase
         */
        'handover'?: boolean | null;
        /**
         * Date on which the element was formally handed over to the maintenance team. ISO 8601 date. May be null.
         * @type {string}
         * @memberof ElementBase
         */
        'handover_date'?: string | null;
    }
    const ElementBaseKindEnum: {
        readonly Totem: "totem";
        readonly InformationPanel: "information_panel";
        readonly DisplayCase: "display_case";
        readonly Obelisk: "obelisk";
        readonly Signpost: "signpost";
    };
    type ElementBaseKindEnum = typeof ElementBaseKindEnum[keyof typeof ElementBaseKindEnum];
    /**
 * Server-set fields that clients can only read. All properties carry readOnly: true. Composed via allOf into each typed element schema.
 * @export
 * @interface ElementReadOnly
 */
    interface ElementReadOnly {
        /**
         * Server-generated UUID primary key. Immutable after creation.
         * @type {string}
         * @memberof ElementReadOnly
         */
        'id'?: string;
        /**
         * Timestamp when the record was first created in the upstream CMS (Strapi). ISO 8601 UTC. Server-set, not writable by clients.
         * @type {string}
         * @memberof ElementReadOnly
         */
        'source_created_at'?: string;
        /**
         * Timestamp of the most recent update in the upstream CMS (Strapi). ISO 8601 UTC. Server-set, not writable by clients.
         * @type {string}
         * @memberof ElementReadOnly
         */
        'source_updated_at'?: string;
        /**
         * Timestamp when the record was published in the upstream CMS (Strapi). ISO 8601 UTC. Server-set, not writable by clients.
         * @type {string}
         * @memberof ElementReadOnly
         */
        'source_published_at'?: string;
    }
    /**
 *
 * @export
 * @interface EventCustomFormat
 */
    interface EventCustomFormat {
        /**
         *
         * @type {string}
         * @memberof EventCustomFormat
         */
        'id': string;
        /**
         *
         * @type {string}
         * @memberof EventCustomFormat
         */
        'type': EventCustomFormatTypeEnum;
        /**
         *
         * @type {EventCustomFormatHeaderText}
         * @memberof EventCustomFormat
         */
        'header_text': EventCustomFormatHeaderText;
        /**
         *
         * @type {EventCustomFormatCause}
         * @memberof EventCustomFormat
         */
        'cause': EventCustomFormatCause;
        /**
         *
         * @type {EventCustomFormatCauseDetail}
         * @memberof EventCustomFormat
         */
        'cause_detail': EventCustomFormatCauseDetail;
        /**
         * INFO - priority 3 \\ WARNING - priority 2 \\ SEVERE - priority 1
         * @type {string}
         * @memberof EventCustomFormat
         */
        'severity_level': EventCustomFormatSeverityLevelEnum;
        /**
         *
         * @type {EventCustomFormatActivePeriod}
         * @memberof EventCustomFormat
         */
        'active_period': EventCustomFormatActivePeriod;
        /**
         *
         * @type {EventCustomFormatDisplayPeriod}
         * @memberof EventCustomFormat
         */
        'display_period': EventCustomFormatDisplayPeriod;
        /**
         *
         * @type {Array<Effect>}
         * @memberof EventCustomFormat
         */
        'effects': Array<Effect>;
        /**
         *
         * @type {EventCustomFormatDescriptionText}
         * @memberof EventCustomFormat
         */
        'description_text': EventCustomFormatDescriptionText;
        /**
         *
         * @type {EventCustomFormatDescriptionHtml}
         * @memberof EventCustomFormat
         */
        'description_html': EventCustomFormatDescriptionHtml;
        /**
         *
         * @type {string}
         * @memberof EventCustomFormat
         */
        'organization_name': string;
        /**
         *
         * @type {EventCustomFormatInformedEntity}
         * @memberof EventCustomFormat
         */
        'informed_entity': EventCustomFormatInformedEntity | null;
        /**
         * Timestamp from when the event was last modified in VYMI
         * @type {string}
         * @memberof EventCustomFormat
         */
        'last_modified_timestamp': string;
        /**
         * Timestamp from when the event was created in VYMI
         * @type {string}
         * @memberof EventCustomFormat
         */
        'created_timestamp': string;
    }
    const EventCustomFormatTypeEnum: {
        readonly Incident: "INCIDENT";
        readonly Disruption: "DISRUPTION";
        readonly ServiceChange: "SERVICE_CHANGE";
    };
    type EventCustomFormatTypeEnum = typeof EventCustomFormatTypeEnum[keyof typeof EventCustomFormatTypeEnum];
    const EventCustomFormatSeverityLevelEnum: {
        readonly Info: "INFO";
        readonly Warning: "WARNING";
        readonly Severe: "SEVERE";
    };
    type EventCustomFormatSeverityLevelEnum = typeof EventCustomFormatSeverityLevelEnum[keyof typeof EventCustomFormatSeverityLevelEnum];
    /**
 * The start and end date/time of the event validity
 * @export
 * @interface EventCustomFormatActivePeriod
 */
    interface EventCustomFormatActivePeriod {
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatActivePeriod
         */
        'start': string;
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatActivePeriod
         */
        'end': string | null;
    }
    /**
 *
 * @export
 * @interface EventCustomFormatCause
 */
    interface EventCustomFormatCause {
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatCause
         */
        'cs': string;
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatCause
         */
        'en'?: string | null;
    }
    /**
 *
 * @export
 * @interface EventCustomFormatCauseDetail
 */
    interface EventCustomFormatCauseDetail {
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatCauseDetail
         */
        'cs'?: string | null;
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatCauseDetail
         */
        'en'?: string | null;
    }
    /**
 * Localized descriptions of the event in HTML format
 * @export
 * @interface EventCustomFormatDescriptionHtml
 */
    interface EventCustomFormatDescriptionHtml {
        /**
         * Event description in Czech in HTML format
         * @type {string}
         * @memberof EventCustomFormatDescriptionHtml
         */
        'cs': string;
        /**
         * Event description in English in HTML format
         * @type {string}
         * @memberof EventCustomFormatDescriptionHtml
         */
        'en'?: string | null;
    }
    /**
 * Localized descriptions of the event in plain text
 * @export
 * @interface EventCustomFormatDescriptionText
 */
    interface EventCustomFormatDescriptionText {
        /**
         * Event description in Czech in plain text
         * @type {string}
         * @memberof EventCustomFormatDescriptionText
         */
        'cs': string;
        /**
         * Event description in English in plain text
         * @type {string}
         * @memberof EventCustomFormatDescriptionText
         */
        'en'?: string | null;
    }
    /**
 * The start and end date/time when the event should be displayed
 * @export
 * @interface EventCustomFormatDisplayPeriod
 */
    interface EventCustomFormatDisplayPeriod {
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatDisplayPeriod
         */
        'start': string;
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatDisplayPeriod
         */
        'end': string | null;
    }
    /**
 *
 * @export
 * @interface EventCustomFormatHeaderText
 */
    interface EventCustomFormatHeaderText {
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatHeaderText
         */
        'cs': string;
        /**
         *
         * @type {string}
         * @memberof EventCustomFormatHeaderText
         */
        'en'?: string | null;
    }
    /**
 *
 * @export
 * @interface EventCustomFormatInformedEntity
 */
    interface EventCustomFormatInformedEntity {
        /**
         *
         * @type {Array<InformedEntityRoute>}
         * @memberof EventCustomFormatInformedEntity
         */
        'routes'?: Array<InformedEntityRoute> | null;
    }
    /**
 *
 * @export
 * @interface FeaturePoint
 */
    interface FeaturePoint {
        /**
         *
         * @type {FeaturePointGeometry}
         * @memberof FeaturePoint
         */
        'geometry': FeaturePointGeometry;
        /**
         *
         * @type {object}
         * @memberof FeaturePoint
         */
        'properties': object;
        /**
         *
         * @type {string}
         * @memberof FeaturePoint
         */
        'type': string;
    }
    /**
 *
 * @export
 * @interface FeaturePointGeometry
 */
    interface FeaturePointGeometry {
        /**
         *
         * @type {string}
         * @memberof FeaturePointGeometry
         */
        'type': string;
        /**
         *
         * @type {Array<number>}
         * @memberof FeaturePointGeometry
         */
        'coordinates': Array<number>;
    }
    /**
 *
 * @export
 * @interface FyprMetadataFieldTranslation
 */
    interface FyprMetadataFieldTranslation {
        /**
         * Czech machine-readable field identifier (IE data-source field name).
         * @type {string}
         * @memberof FyprMetadataFieldTranslation
         */
        'slug_cs': string;
        /**
         * Czech human-readable field title.
         * @type {string}
         * @memberof FyprMetadataFieldTranslation
         */
        'title_cs': string;
    }
    /**
 *
 * @export
 * @interface FyprMetadataKindEntry
 */
    interface FyprMetadataKindEntry {
        /**
         *
         * @type {Array<FyprMetadataKindLinksInner>}
         * @memberof FyprMetadataKindEntry
         */
        'links': Array<FyprMetadataKindLinksInner>;
        /**
         *
         * @type {FyprMetadataKindTranslations}
         * @memberof FyprMetadataKindEntry
         */
        'translations': FyprMetadataKindTranslations;
    }
    /**
 *
 * @export
 * @interface FyprMetadataKindLinksInner
 */
    interface FyprMetadataKindLinksInner {
        /**
         * Link relation type.
         * @type {string}
         * @memberof FyprMetadataKindLinksInner
         */
        'rel': string;
        /**
         * Path to the list endpoint for this element kind.
         * @type {string}
         * @memberof FyprMetadataKindLinksInner
         */
        'href': string;
    }
    /**
 *
 * @export
 * @interface FyprMetadataKindTranslation
 */
    interface FyprMetadataKindTranslation {
        /**
         * Database table name of the element kind (snake_case).
         * @type {string}
         * @memberof FyprMetadataKindTranslation
         */
        'slug_en': string;
        /**
         * Czech plural name of the element kind.
         * @type {string}
         * @memberof FyprMetadataKindTranslation
         */
        'title_cs': string;
        /**
         * Czech singular name of the element kind.
         * @type {string}
         * @memberof FyprMetadataKindTranslation
         */
        'title_cs_singular': string;
    }
    /**
 *
 * @export
 * @interface FyprMetadataKindTranslations
 */
    interface FyprMetadataKindTranslations {
        /**
         *
         * @type {FyprMetadataKindTranslation}
         * @memberof FyprMetadataKindTranslations
         */
        'kind': FyprMetadataKindTranslation;
        /**
         * Map of English attribute slugs to their translation data. Keys are OG model attribute names; values contain the Czech slug and human-readable label.
         * @type {{ [key: string]: FyprMetadataFieldTranslation; }}
         * @memberof FyprMetadataKindTranslations
         */
        'attributes': {
            [key: string]: FyprMetadataFieldTranslation;
        };
    }
    /**
 *
 * @export
 * @interface GTFSRoute
 */
    interface GTFSRoute {
        /**
         *
         * @type {string}
         * @memberof GTFSRoute
         */
        'agency_id': string;
        /**
         *
         * @type {boolean}
         * @memberof GTFSRoute
         */
        'is_night': boolean;
        /**
         *
         * @type {boolean}
         * @memberof GTFSRoute
         */
        'is_regional': boolean;
        /**
         *
         * @type {boolean}
         * @memberof GTFSRoute
         */
        'is_substitute_transport': boolean;
        /**
         *
         * @type {string}
         * @memberof GTFSRoute
         */
        'last_modify'?: string | null;
        /**
         *
         * @type {string}
         * @memberof GTFSRoute
         */
        'route_color': string;
        /**
         *
         * @type {string}
         * @memberof GTFSRoute
         */
        'route_desc'?: string | null;
        /**
         *
         * @type {string}
         * @memberof GTFSRoute
         */
        'route_id': string;
        /**
         *
         * @type {string}
         * @memberof GTFSRoute
         */
        'route_long_name': string;
        /**
         *
         * @type {string}
         * @memberof GTFSRoute
         */
        'route_short_name': string;
        /**
         *
         * @type {string}
         * @memberof GTFSRoute
         */
        'route_text_color': string;
        /**
         *
         * @type {number}
         * @memberof GTFSRoute
         */
        'route_type': number;
        /**
         *
         * @type {string}
         * @memberof GTFSRoute
         */
        'route_url': string;
    }
    /**
 *
 * @export
 * @interface GTFSService
 */
    interface GTFSService {
        /**
         *
         * @type {string}
         * @memberof GTFSService
         */
        'end_date': string;
        /**
         *
         * @type {string}
         * @memberof GTFSService
         */
        'last_modify'?: string | null;
        /**
         *
         * @type {number}
         * @memberof GTFSService
         */
        'monday': number;
        /**
         *
         * @type {number}
         * @memberof GTFSService
         */
        'tuesday': number;
        /**
         *
         * @type {number}
         * @memberof GTFSService
         */
        'wednesday': number;
        /**
         *
         * @type {number}
         * @memberof GTFSService
         */
        'thursday': number;
        /**
         *
         * @type {number}
         * @memberof GTFSService
         */
        'friday': number;
        /**
         *
         * @type {number}
         * @memberof GTFSService
         */
        'saturday': number;
        /**
         *
         * @type {number}
         * @memberof GTFSService
         */
        'sunday': number;
        /**
         *
         * @type {string}
         * @memberof GTFSService
         */
        'service_id'?: string;
        /**
         *
         * @type {string}
         * @memberof GTFSService
         */
        'start_date'?: string;
    }
    /**
 *
 * @export
 * @interface GTFSShape
 */
    interface GTFSShape {
        /**
         *
         * @type {number}
         * @memberof GTFSShape
         */
        'shape_dist_traveled': number;
        /**
         *
         * @type {string}
         * @memberof GTFSShape
         */
        'shape_id': string;
        /**
         *
         * @type {number}
         * @memberof GTFSShape
         */
        'shape_pt_sequence': number;
    }
    /**
 *
 * @export
 * @interface GTFSStop
 */
    interface GTFSStop {
        /**
         *
         * @type {number}
         * @memberof GTFSStop
         */
        'location_type': number;
        /**
         *
         * @type {string}
         * @memberof GTFSStop
         */
        'parent_station': string | null;
        /**
         *
         * @type {string}
         * @memberof GTFSStop
         */
        'platform_code': string;
        /**
         *
         * @type {string}
         * @memberof GTFSStop
         */
        'stop_id': string;
        /**
         *
         * @type {string}
         * @memberof GTFSStop
         */
        'stop_name': string;
        /**
         *
         * @type {number}
         * @memberof GTFSStop
         */
        'wheelchair_boarding': number;
        /**
         *
         * @type {string}
         * @memberof GTFSStop
         */
        'zone_id': string;
        /**
         *
         * @type {string}
         * @memberof GTFSStop
         */
        'level_id': string | null;
    }
    /**
 *
 * @export
 * @interface GTFSStopTime
 */
    interface GTFSStopTime {
        /**
         *
         * @type {string}
         * @memberof GTFSStopTime
         */
        'arrival_time': string;
        /**
         *
         * @type {string}
         * @memberof GTFSStopTime
         */
        'departure_time': string;
        /**
         *
         * @type {string}
         * @memberof GTFSStopTime
         */
        'drop_off_type': string;
        /**
         *
         * @type {string}
         * @memberof GTFSStopTime
         */
        'last_modify'?: string | null;
        /**
         *
         * @type {string}
         * @memberof GTFSStopTime
         */
        'pickup_type': string;
        /**
         *
         * @type {number}
         * @memberof GTFSStopTime
         */
        'shape_dist_traveled': number;
        /**
         *
         * @type {string}
         * @memberof GTFSStopTime
         */
        'stop_headsign'?: string;
        /**
         *
         * @type {string}
         * @memberof GTFSStopTime
         */
        'stop_id': string;
        /**
         *
         * @type {number}
         * @memberof GTFSStopTime
         */
        'stop_sequence': number;
        /**
         *
         * @type {string}
         * @memberof GTFSStopTime
         */
        'trip_id': string;
    }
    /**
 *
 * @export
 * @interface GTFSTrip
 */
    interface GTFSTrip {
        /**
         *
         * @type {string}
         * @memberof GTFSTrip
         */
        'trip_id': string;
        /**
         *
         * @type {number}
         * @memberof GTFSTrip
         */
        'bikes_allowed': number;
        /**
         *
         * @type {string}
         * @memberof GTFSTrip
         */
        'block_id'?: string | null;
        /**
         *
         * @type {number}
         * @memberof GTFSTrip
         */
        'direction_id'?: number;
        /**
         *
         * @type {number}
         * @memberof GTFSTrip
         */
        'exceptional'?: number;
        /**
         *
         * @type {string}
         * @memberof GTFSTrip
         */
        'last_modify'?: string | null;
        /**
         *
         * @type {string}
         * @memberof GTFSTrip
         */
        'route_id': string;
        /**
         *
         * @type {string}
         * @memberof GTFSTrip
         */
        'service_id': string;
        /**
         *
         * @type {string}
         * @memberof GTFSTrip
         */
        'shape_id': string;
        /**
         *
         * @type {string}
         * @memberof GTFSTrip
         */
        'trip_headsign': string;
        /**
         *
         * @type {number}
         * @memberof GTFSTrip
         */
        'wheelchair_accessible': number;
    }
    /**
 * GeoJson point
 * @export
 * @interface GeometryPoint
 */
    interface GeometryPoint {
        /**
         * Point
         * @type {Array<number>}
         * @memberof GeometryPoint
         */
        'coordinates'?: Array<number>;
        /**
         *
         * @type {string}
         * @memberof GeometryPoint
         */
        'type'?: GeometryPointTypeEnum;
    }
    const GeometryPointTypeEnum: {
        readonly Point: "Point";
    };
    type GeometryPointTypeEnum = typeof GeometryPointTypeEnum[keyof typeof GeometryPointTypeEnum];
    /**
 * @type GetFyprElementDetail200Response
 * @export
 */
    type GetFyprElementDetail200Response = DisplayCase | InformationPanel | Obelisk | Signpost | Totem;
    /**
 *
 * @export
 * @interface GetFyprElementDetail404Response
 */
    interface GetFyprElementDetail404Response {
        /**
         *
         * @type {string}
         * @memberof GetFyprElementDetail404Response
         */
        'error_message': string;
        /**
         *
         * @type {number}
         * @memberof GetFyprElementDetail404Response
         */
        'error_status': number;
        /**
         *
         * @type {string}
         * @memberof GetFyprElementDetail404Response
         */
        'error_info'?: string | null;
    }
    /**
 *
 * @export
 * @interface GetFyprMetadata200Response
 */
    interface GetFyprMetadata200Response {
        /**
         *
         * @type {GetFyprMetadata200ResponseElements}
         * @memberof GetFyprMetadata200Response
         */
        'elements': GetFyprMetadata200ResponseElements;
    }
    /**
 *
 * @export
 * @interface GetFyprMetadata200ResponseElements
 */
    interface GetFyprMetadata200ResponseElements {
        /**
         *
         * @type {FyprMetadataKindEntry}
         * @memberof GetFyprMetadata200ResponseElements
         */
        'display-cases': FyprMetadataKindEntry;
        /**
         *
         * @type {FyprMetadataKindEntry}
         * @memberof GetFyprMetadata200ResponseElements
         */
        'information-panels': FyprMetadataKindEntry;
        /**
         *
         * @type {FyprMetadataKindEntry}
         * @memberof GetFyprMetadata200ResponseElements
         */
        'obelisks': FyprMetadataKindEntry;
        /**
         *
         * @type {FyprMetadataKindEntry}
         * @memberof GetFyprMetadata200ResponseElements
         */
        'signposts': FyprMetadataKindEntry;
        /**
         *
         * @type {FyprMetadataKindEntry}
         * @memberof GetFyprMetadata200ResponseElements
         */
        'totems': FyprMetadataKindEntry;
    }
    /**
 * Fully composed information panel schema. Combines InformationPanelBase (writable type-specific and base fields) with ElementReadOnly (server-set timestamps and id). Returned by the list endpoint GET /v1/information-panels.
 * @export
 * @interface InformationPanel
 */
    interface InformationPanel {
        /**
         * Server-generated UUID primary key. Immutable after creation.
         * @type {string}
         * @memberof InformationPanel
         */
        'id': string;
        /**
         * Timestamp when the record was first created in the upstream CMS (Strapi). ISO 8601 UTC. Server-set, not writable by clients.
         *