Skip to content

Models

DestinationWeatherResponse

Bases: HEREModel

A class representing the Weather Forecasts for DestinationWeather Api.

Source code in herepy/models.py 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
class DestinationWeatherResponse(HEREModel):
    """A class representing the Weather Forecasts for DestinationWeather Api."""

    def __init__(self, param_defaults, **kwargs):
        super(DestinationWeatherResponse, self).__init__()
        self.param_defaults = param_defaults

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

    @classmethod
    def new_from_jsondict(cls, data, param_defaults, **kwargs):
        """Create a new instance based on a JSON dict. Any kwargs should be
        supplied by the inherited, calling class.

        Args:
            data (dict):
              A JSON dict, as converted from the JSON in the here API.
        """

        json_data = data.copy()
        if kwargs:
            for key, val in kwargs.items():
                json_data[key] = val

        c = cls(param_defaults, **json_data)
        c._json = data
        return c

new_from_jsondict(data, param_defaults, **kwargs) classmethod

Create a new instance based on a JSON dict. Any kwargs should be supplied by the inherited, calling class.

Parameters:

Name Type Description Default
data dict

A JSON dict, as converted from the JSON in the here API.

 required
Source code in herepy/models.py 
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
@classmethod
def new_from_jsondict(cls, data, param_defaults, **kwargs):
    """Create a new instance based on a JSON dict. Any kwargs should be
    supplied by the inherited, calling class.

    Args:
        data (dict):
          A JSON dict, as converted from the JSON in the here API.
    """

    json_data = data.copy()
    if kwargs:
        for key, val in kwargs.items():
            json_data[key] = val

    c = cls(param_defaults, **json_data)
    c._json = data
    return c

EVChargingStationsResponse

Bases: HEREModel

A class representing the EV Charging Stations response data.

Source code in herepy/models.py 
231
232
233
234
235
236
237
238
239
240
241
242
243
class EVChargingStationsResponse(HEREModel):
    """A class representing the EV Charging Stations response data."""

    def __init__(self, **kwargs):
        super(EVChargingStationsResponse, self).__init__()
        self.param_defaults = {
            "hasMore": False,
            "count": 0,
            "evStations": None,
        }

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

GeocoderAutoCompleteResponse

Bases: HEREModel

A class representing the Geocoder Autocomplete Api response data.

Source code in herepy/models.py 
140
141
142
143
144
145
146
147
148
class GeocoderAutoCompleteResponse(HEREModel):
    """A class representing the Geocoder Autocomplete Api response data."""

    def __init__(self, **kwargs):
        super(GeocoderAutoCompleteResponse, self).__init__()
        self.param_defaults = {"items": None}

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

GeocoderResponse

Bases: HEREModel

A class representing the Geocoder Api response data.

Source code in herepy/models.py 
81
82
83
84
85
86
87
88
89
class GeocoderResponse(HEREModel):
    """A class representing the Geocoder Api response data."""

    def __init__(self, **kwargs):
        super(GeocoderResponse, self).__init__()
        self.param_defaults = {"items": None}

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

GeocoderReverseResponse

Bases: HEREModel

A class representing the Geocoder Reverse Api response data.

Source code in herepy/models.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
class GeocoderReverseResponse(HEREModel):
    """A class representing the Geocoder Reverse Api response data."""

    def __init__(self, **kwargs):
        super(GeocoderReverseResponse, self).__init__()
        self.param_defaults = {"items": None}

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

HEREModel

Bases: object

Base class from which all here models will inherit.

Source code in herepy/models.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
class HEREModel(object):
    """Base class from which all here models will inherit."""

    def __init__(self, **kwargs):
        self.param_defaults = {}

    def __str__(self):
        """Returns a string representation of HEREModel. By default
        this is the same as as_json_string()."""
        return self.as_json_string()

    def __eq__(self, other):
        return other and self.as_dict() == other.as_dict()

    def __ne__(self, other):
        return not self.__eq__(other)

    def as_json_string(self):
        """Returns the HEREModel as a JSON string based on key/value
        pairs returned from the as_dict() method."""
        return json.dumps(self.as_dict(), sort_keys=True)

    def as_dict(self):
        """Create a dictionary representation of the object. Please see inline
        comments on construction when dictionaries contain HEREModels."""
        data = {}

        for (key, value) in self.param_defaults.items():

            # If the value is a list, we need to create a list to hold the
            # dicts created by an object supporting the as_dict() method,
            # i.e., if it inherits from HEREModel. If the item in the list
            # doesn't support the as_dict() method, then we assign the value
            # directly. An example being a list of Media objects contained
            # within a Status object.
            if isinstance(getattr(self, key, None), (list, tuple, set)):
                data[key] = list()
                for subobj in getattr(self, key, None):
                    if getattr(subobj, "as_dict", None):
                        data[key].append(subobj.as_dict())
                    else:
                        data[key].append(subobj)

            # Not a list, *but still a subclass of HEREModel* and
            # and we can assign the data[key] directly with the as_dict()
            # method of the object. An example being a Status object contained
            # within a User object.
            elif getattr(getattr(self, key, None), "as_dict", None):
                data[key] = getattr(self, key).as_dict()

            # If the value doesn't have an as_dict() method, i.e., it's not
            # something that subclasses HEREModel, then we can use direct
            # assigment.
            elif getattr(self, key, None):
                data[key] = getattr(self, key, None)
        return data

    @classmethod
    def new_from_jsondict(cls, data, **kwargs):
        """Create a new instance based on a JSON dict. Any kwargs should be
        supplied by the inherited, calling class.

        Args:
            data (dict):
              A JSON dict, as converted from the JSON in the here API.
        """

        json_data = data.copy()
        if kwargs:
            for key, val in kwargs.items():
                json_data[key] = val

        c = cls(**json_data)
        c._json = data
        return c

__str__()

Returns a string representation of HEREModel. By default this is the same as as_json_string().

Source code in herepy/models.py 
10
11
12
13
def __str__(self):
    """Returns a string representation of HEREModel. By default
    this is the same as as_json_string()."""
    return self.as_json_string()

as_dict()

Create a dictionary representation of the object. Please see inline comments on construction when dictionaries contain HEREModels.

Source code in herepy/models.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def as_dict(self):
    """Create a dictionary representation of the object. Please see inline
    comments on construction when dictionaries contain HEREModels."""
    data = {}

    for (key, value) in self.param_defaults.items():

        # If the value is a list, we need to create a list to hold the
        # dicts created by an object supporting the as_dict() method,
        # i.e., if it inherits from HEREModel. If the item in the list
        # doesn't support the as_dict() method, then we assign the value
        # directly. An example being a list of Media objects contained
        # within a Status object.
        if isinstance(getattr(self, key, None), (list, tuple, set)):
            data[key] = list()
            for subobj in getattr(self, key, None):
                if getattr(subobj, "as_dict", None):
                    data[key].append(subobj.as_dict())
                else:
                    data[key].append(subobj)

        # Not a list, *but still a subclass of HEREModel* and
        # and we can assign the data[key] directly with the as_dict()
        # method of the object. An example being a Status object contained
        # within a User object.
        elif getattr(getattr(self, key, None), "as_dict", None):
            data[key] = getattr(self, key).as_dict()

        # If the value doesn't have an as_dict() method, i.e., it's not
        # something that subclasses HEREModel, then we can use direct
        # assigment.
        elif getattr(self, key, None):
            data[key] = getattr(self, key, None)
    return data

as_json_string()

Returns the HEREModel as a JSON string based on key/value pairs returned from the as_dict() method.

Source code in herepy/models.py 
21
22
23
24
def as_json_string(self):
    """Returns the HEREModel as a JSON string based on key/value
    pairs returned from the as_dict() method."""
    return json.dumps(self.as_dict(), sort_keys=True)

new_from_jsondict(data, **kwargs) classmethod

Create a new instance based on a JSON dict. Any kwargs should be supplied by the inherited, calling class.

Parameters:

Name Type Description Default
data dict

A JSON dict, as converted from the JSON in the here API.

 required
Source code in herepy/models.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
@classmethod
def new_from_jsondict(cls, data, **kwargs):
    """Create a new instance based on a JSON dict. Any kwargs should be
    supplied by the inherited, calling class.

    Args:
        data (dict):
          A JSON dict, as converted from the JSON in the here API.
    """

    json_data = data.copy()
    if kwargs:
        for key, val in kwargs.items():
            json_data[key] = val

    c = cls(**json_data)
    c._json = data
    return c

IsolineRoutingResponse

Bases: HEREModel

A class representing the Isoline Routing API Flow response data.

Source code in herepy/models.py 
289
290
291
292
293
294
295
296
297
298
299
300
301
302
class IsolineRoutingResponse(HEREModel):
    """A class representing the Isoline Routing API Flow response data."""

    def __init__(self, **kwargs):
        super(IsolineRoutingResponse, self).__init__()
        self.param_defaults = {
            "departure": None,
            "arrival": None,
            "isolines": [],
            "error": None,
        }

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

PlacesResponse

Bases: HEREModel

A class representing the Places (Search) Api response data.

Source code in herepy/models.py 
162
163
164
165
166
167
168
169
170
class PlacesResponse(HEREModel):
    """A class representing the Places (Search) Api response data."""

    def __init__(self, **kwargs):
        super(PlacesResponse, self).__init__()
        self.param_defaults = {"items": None}

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

PublicTransitResponse

Bases: HEREModel

A class representing the Public Transit Api response data.

Source code in herepy/models.py 
173
174
175
176
177
178
179
180
181
class PublicTransitResponse(HEREModel):
    """A class representing the Public Transit Api response data."""

    def __init__(self, **kwargs):
        super(PublicTransitResponse, self).__init__()
        self.param_defaults = {"Res": None}

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

RmeResponse

Bases: HEREModel

A class representing the RME (Route Matcher) Api response data.

Source code in herepy/models.py 
151
152
153
154
155
156
157
158
159
class RmeResponse(HEREModel):
    """A class representing the RME (Route Matcher) Api response data."""

    def __init__(self, **kwargs):
        super(RmeResponse, self).__init__()
        self.param_defaults = {"RouteLinks": [], "TracePoints": [], "Warnings": []}

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

RoutingMatrixResponse

Bases: HEREModel

A class representing the Routing Api matrix response data.

Source code in herepy/models.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
class RoutingMatrixResponse(HEREModel):
    """A class representing the Routing Api matrix response data."""

    def __init__(self, **kwargs):
        super(RoutingMatrixResponse, self).__init__()
        self.param_defaults = {
            "matrixId": None,
            "matrix": None,
            "regionDefinition": None,
        }

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

RoutingResponse

Bases: HEREModel

A class representing the Routing Api response data.

Source code in herepy/models.py 
103
104
105
106
107
108
109
110
111
class RoutingResponse(HEREModel):
    """A class representing the Routing Api response data."""

    def __init__(self, **kwargs):
        super(RoutingResponse, self).__init__()
        self.param_defaults = {"response": None, "route_short": None}

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

RoutingResponseV8

Bases: HEREModel

A class representing the Routing Api v8 response data.

Source code in herepy/models.py 
114
115
116
117
118
119
120
121
122
class RoutingResponseV8(HEREModel):
    """A class representing the Routing Api v8 response data."""

    def __init__(self, **kwargs):
        super(RoutingResponseV8, self).__init__()
        self.param_defaults = {"routes": None}

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

TrafficFlowAvailabilityResponse

Bases: HEREModel

A class representing the Traffic API Flow availability response data.

Source code in herepy/models.py 
275
276
277
278
279
280
281
282
283
284
285
286
class TrafficFlowAvailabilityResponse(HEREModel):
    """A class representing the Traffic API Flow availability response data."""

    def __init__(self, **kwargs):
        super(TrafficFlowAvailabilityResponse, self).__init__()
        self.param_defaults = {
            "Response": [],
            "error": None,
        }

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

TrafficFlowResponse

Bases: HEREModel

A class representing the Traffic API Flow response data.

Source code in herepy/models.py 
261
262
263
264
265
266
267
268
269
270
271
272
class TrafficFlowResponse(HEREModel):
    """A class representing the Traffic API Flow response data."""

    def __init__(self, **kwargs):
        super(TrafficFlowResponse, self).__init__()
        self.param_defaults = {
            "RWS": [],
            "error": None,
        }

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

TrafficIncidentResponse

Bases: HEREModel

A class representing the Traffic Incidents response provided by Traffic Api.

Source code in herepy/models.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
class TrafficIncidentResponse(HEREModel):
    """A class representing the Traffic Incidents response provided by Traffic Api."""

    def __init__(self, **kwargs):
        super(TrafficIncidentResponse, self).__init__()
        self.param_defaults = {
            "TIMESTAMP": None,
            "VERSION": None,
            "TRAFFIC_ITEMS": None,
            "EXTENDED_COUNTRY_CODE": None,
            "error": None,
        }

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))

WaypointSequenceResponse

Bases: HEREModel

A class representing the Fleet Telematics Waypoint Sequence response data.

Source code in herepy/models.py 
246
247
248
249
250
251
252
253
254
255
256
257
258
class WaypointSequenceResponse(HEREModel):
    """A class representing the Fleet Telematics Waypoint Sequence response data."""

    def __init__(self, **kwargs):
        super(WaypointSequenceResponse, self).__init__()
        self.param_defaults = {
            "results": None,
            "errors": None,
            "warnings": None,
        }

        for (param, default) in self.param_defaults.items():
            setattr(self, param, kwargs.get(param, default))