Module redvox.cloud.routes

This module contains the route definitions for interacting with the RedVox Cloud API.

"""
This module contains the route definitions for interacting with the RedVox Cloud API.
"""


class RoutesV1:
    """
    Route definitions for version 1 of the RedVox Cloud API.
    """

    HEALTH_CHECK: str = "/"
    AUTH_USER: str = "/api/v1/auth"
    VALIDATE_TOKEN: str = "/api/v1/auth/token"
    REFRESH_TOKEN: str = "/api/v1/auth/refresh"
    METADATA_REQ: str = "/api/v1/metadata"
    METADATA_REQ_M: str = "/api/v1/metadata/m"
    TIMING_METADATA_REQ: str = "/api/v1/metadata/timing"
    STATION_STATUS_TIMELINE: str = "/api/v1/metadata/timeline"
    DATA_RANGE_REQ: str = "/api/v1/data/range"
    DATA_RANGE_REQ_M: str = "/api/v1/data/range/m"
    DATA_REPORT_REQ: str = "/api/v1/data/report"
    STATION_STATS: str = "/api/v1/metadata/stats"


class RoutesV2:
    """
    Route definitions for version 2 of the RedVox Cloud API.
    """

    GEO_METADATA_REQ: str = "/api/v2/metadata/geo"


class RoutesV3:
    SESSION_MODEL: str = "/api/v3/session_model"
    SESSION_MODELS: str = "/api/v3/session_models"
    DYNAMIC_SESSION_MODEL: str = "/api/v3/dynamic_session_model"

Classes

class RoutesV1

Route definitions for version 1 of the RedVox Cloud API.

Expand source code

class RoutesV1:
    """
    Route definitions for version 1 of the RedVox Cloud API.
    """

    HEALTH_CHECK: str = "/"
    AUTH_USER: str = "/api/v1/auth"
    VALIDATE_TOKEN: str = "/api/v1/auth/token"
    REFRESH_TOKEN: str = "/api/v1/auth/refresh"
    METADATA_REQ: str = "/api/v1/metadata"
    METADATA_REQ_M: str = "/api/v1/metadata/m"
    TIMING_METADATA_REQ: str = "/api/v1/metadata/timing"
    STATION_STATUS_TIMELINE: str = "/api/v1/metadata/timeline"
    DATA_RANGE_REQ: str = "/api/v1/data/range"
    DATA_RANGE_REQ_M: str = "/api/v1/data/range/m"
    DATA_REPORT_REQ: str = "/api/v1/data/report"
    STATION_STATS: str = "/api/v1/metadata/stats"

Class variables

var AUTH_USER : str

var DATA_RANGE_REQ : str

var DATA_RANGE_REQ_M : str

var DATA_REPORT_REQ : str

var HEALTH_CHECK : str

var METADATA_REQ : str

var METADATA_REQ_M : str

var REFRESH_TOKEN : str

var STATION_STATS : str

var STATION_STATUS_TIMELINE : str

var TIMING_METADATA_REQ : str

var VALIDATE_TOKEN : str

class RoutesV2

Route definitions for version 2 of the RedVox Cloud API.

Expand source code

class RoutesV2:
    """
    Route definitions for version 2 of the RedVox Cloud API.
    """

    GEO_METADATA_REQ: str = "/api/v2/metadata/geo"

Class variables

var GEO_METADATA_REQ : str

class RoutesV3

Expand source code

class RoutesV3:
    SESSION_MODEL: str = "/api/v3/session_model"
    SESSION_MODELS: str = "/api/v3/session_models"
    DYNAMIC_SESSION_MODEL: str = "/api/v3/dynamic_session_model"

Class variables

var DYNAMIC_SESSION_MODEL : str

var SESSION_MODEL : str

var SESSION_MODELS : str