Module pyaurorax.search.api.classes.response

Class definition for an AuroraX API response

Classes

class AuroraXAPIResponse (request: Any, data: Any, status_code: int)

Expand source code

class AuroraXAPIResponse:
    """
    Class definition for an AuroraX API response

    Attributes:
        request (Any): the request object
        data (Any): the data received as part of the request
        status_code (int): the HTTP status code received when making the request
    """

    def __init__(self, request: Any, data: Any, status_code: int):
        self.request = request
        self.data = data
        self.status_code = status_code

    def __str__(self) -> str:
        return self.__repr__()

    def __repr__(self) -> str:
        return f"AuroraXAPIResponse [{self.status_code}] ({responses[self.status_code]})"

Class definition for an AuroraX API response

Attributes

request : Any

the request object

data : Any

the data received as part of the request

status_code : int

the HTTP status code received when making the request