stadiamaps 3.2.1__py3-none-any.whl → 5.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- stadiamaps/__init__.py +32 -11
- stadiamaps/api/geocoding_api.py +128 -116
- stadiamaps/api/geospatial_api.py +7 -3
- stadiamaps/api/routing_api.py +33 -19
- stadiamaps/api_client.py +21 -5
- stadiamaps/configuration.py +156 -40
- stadiamaps/exceptions.py +1 -1
- stadiamaps/models/__init__.py +31 -10
- stadiamaps/models/access.py +1 -1
- stadiamaps/models/admin_region.py +1 -1
- stadiamaps/models/administrative.py +1 -1
- stadiamaps/models/annotation_filters.py +124 -0
- stadiamaps/models/auto_costing_options.py +1 -1
- stadiamaps/models/base_costing_options.py +1 -1
- stadiamaps/models/base_trace_request.py +7 -7
- stadiamaps/models/bicycle_costing_options.py +1 -1
- stadiamaps/models/bike_network.py +1 -1
- stadiamaps/models/bulk_request.py +1 -1
- stadiamaps/models/bulk_request_query.py +1 -1
- stadiamaps/models/bulk_search_response.py +4 -4
- stadiamaps/models/contour.py +1 -1
- stadiamaps/models/coordinate.py +1 -1
- stadiamaps/models/costing_model.py +1 -1
- stadiamaps/models/costing_options.py +1 -1
- stadiamaps/models/directions_options.py +4 -4
- stadiamaps/models/distance_unit.py +1 -1
- stadiamaps/models/edge_sign.py +1 -1
- stadiamaps/models/edge_use.py +1 -1
- stadiamaps/models/end_node.py +4 -4
- stadiamaps/models/extended_directions_options.py +121 -0
- stadiamaps/models/geo_attributes.py +1 -1
- stadiamaps/models/geo_json_geometry.py +1 -1
- stadiamaps/models/geo_json_geometry_base.py +1 -1
- stadiamaps/models/geo_json_line_string.py +1 -1
- stadiamaps/models/geo_json_point.py +1 -1
- stadiamaps/models/geo_json_polygon.py +1 -1
- stadiamaps/models/{pelias_response.py → geocode_response.py} +11 -11
- stadiamaps/models/{pelias_geo_json_feature.py → geocoding_geo_json_feature.py} +8 -8
- stadiamaps/models/{pelias_geo_json_properties.py → geocoding_geo_json_properties.py} +40 -14
- stadiamaps/models/{pelias_geo_json_properties_addendum.py → geocoding_geo_json_properties_addendum.py} +7 -7
- stadiamaps/models/{pelias_geo_json_properties_addendum_osm.py → geocoding_geo_json_properties_addendum_osm.py} +5 -5
- stadiamaps/models/{pelias_layer.py → geocoding_layer.py} +3 -3
- stadiamaps/models/geocoding_object.py +1 -1
- stadiamaps/models/{pelias_source.py → geocoding_source.py} +4 -3
- stadiamaps/models/height_request.py +4 -4
- stadiamaps/models/height_response.py +4 -4
- stadiamaps/models/highway_classification.py +1 -1
- stadiamaps/models/intersecting_edge.py +1 -1
- stadiamaps/models/isochrone_costing_model.py +1 -1
- stadiamaps/models/isochrone_feature.py +1 -1
- stadiamaps/models/isochrone_properties.py +1 -1
- stadiamaps/models/isochrone_request.py +7 -7
- stadiamaps/models/isochrone_response.py +4 -4
- stadiamaps/models/locate_detailed_edge.py +1 -1
- stadiamaps/models/locate_edge.py +1 -1
- stadiamaps/models/locate_edge_info.py +1 -1
- stadiamaps/models/locate_node.py +1 -1
- stadiamaps/models/locate_object.py +7 -7
- stadiamaps/models/low_speed_vehicle_costing_options.py +1 -1
- stadiamaps/models/maneuver_sign.py +13 -13
- stadiamaps/models/maneuver_sign_element.py +1 -1
- stadiamaps/models/map_match_costing_model.py +1 -1
- stadiamaps/models/map_match_request.py +35 -11
- stadiamaps/models/map_match_route_response.py +4 -4
- stadiamaps/models/map_match_trace_options.py +1 -1
- stadiamaps/models/map_match_waypoint.py +1 -1
- stadiamaps/models/matched_point.py +1 -1
- stadiamaps/models/matrix_costing_model.py +1 -1
- stadiamaps/models/matrix_distance.py +1 -1
- stadiamaps/models/matrix_request.py +10 -10
- stadiamaps/models/matrix_response.py +16 -16
- stadiamaps/models/matrix_waypoint.py +1 -1
- stadiamaps/models/motor_scooter_costing_options.py +1 -1
- stadiamaps/models/motorcycle_costing_options.py +1 -1
- stadiamaps/models/nearest_roads_request.py +7 -7
- stadiamaps/models/node_id.py +1 -1
- stadiamaps/models/node_type.py +1 -1
- stadiamaps/models/optimized_route_request.py +35 -11
- stadiamaps/models/osrm_admin.py +103 -0
- stadiamaps/models/osrm_annotation.py +117 -0
- stadiamaps/models/osrm_banner_component.py +113 -0
- stadiamaps/models/osrm_banner_content.py +131 -0
- stadiamaps/models/osrm_banner_instruction.py +112 -0
- stadiamaps/models/osrm_base_api_response.py +112 -0
- stadiamaps/models/osrm_guidance_modifier.py +44 -0
- stadiamaps/models/osrm_intersection.py +145 -0
- stadiamaps/models/osrm_lane.py +111 -0
- stadiamaps/models/osrm_route.py +119 -0
- stadiamaps/models/osrm_route_leg.py +148 -0
- stadiamaps/models/osrm_route_response.py +132 -0
- stadiamaps/models/osrm_route_step.py +185 -0
- stadiamaps/models/osrm_speed_limit.py +117 -0
- stadiamaps/models/osrm_step_maneuver.py +127 -0
- stadiamaps/models/osrm_via_waypoint.py +105 -0
- stadiamaps/models/osrm_voice_instruction.py +105 -0
- stadiamaps/models/osrm_waypoint.py +108 -0
- stadiamaps/models/pedestrian_costing_options.py +1 -1
- stadiamaps/models/restrictions.py +1 -1
- stadiamaps/models/road_class.py +1 -1
- stadiamaps/models/route200_response.py +138 -0
- stadiamaps/models/route_leg.py +4 -4
- stadiamaps/models/route_maneuver.py +1 -1
- stadiamaps/models/route_request.py +34 -12
- stadiamaps/models/route_response.py +4 -4
- stadiamaps/models/route_response_alternates_inner.py +1 -1
- stadiamaps/models/route_summary.py +1 -1
- stadiamaps/models/route_trip.py +13 -13
- stadiamaps/models/{valhalla_languages.py → routing_languages.py} +4 -4
- stadiamaps/models/{valhalla_long_units.py → routing_long_units.py} +4 -4
- stadiamaps/models/routing_response_waypoint.py +1 -1
- stadiamaps/models/routing_waypoint.py +1 -1
- stadiamaps/models/routing_waypoint_all_of_search_filter.py +1 -1
- stadiamaps/models/search_query.py +6 -6
- stadiamaps/models/search_structured_query.py +6 -6
- stadiamaps/models/simple_routing_waypoint.py +1 -1
- stadiamaps/models/speeds.py +1 -1
- stadiamaps/models/trace_attribute_filter_options.py +1 -1
- stadiamaps/models/trace_attribute_key.py +1 -1
- stadiamaps/models/trace_attributes_base_response.py +10 -10
- stadiamaps/models/trace_attributes_request.py +13 -11
- stadiamaps/models/trace_attributes_response.py +16 -16
- stadiamaps/models/trace_edge.py +2 -2
- stadiamaps/models/travel_mode.py +1 -1
- stadiamaps/models/traversability.py +1 -1
- stadiamaps/models/truck_costing_options.py +1 -1
- stadiamaps/models/tz_response.py +1 -1
- stadiamaps/models/warning.py +1 -1
- stadiamaps/rest.py +2 -2
- {stadiamaps-3.2.1.dist-info → stadiamaps-5.0.0.dist-info}/METADATA +14 -6
- stadiamaps-5.0.0.dist-info/RECORD +157 -0
- {stadiamaps-3.2.1.dist-info → stadiamaps-5.0.0.dist-info}/WHEEL +1 -1
- stadiamaps/models/pelias_response_geocoding.py +0 -89
- stadiamaps/models/route_response_trip.py +0 -117
- stadiamaps/models/trace_attributes_response_all_of.py +0 -96
- stadiamaps-3.2.1.dist-info/RECORD +0 -139
- {stadiamaps-3.2.1.dist-info → stadiamaps-5.0.0.dist-info}/LICENSE.txt +0 -0
- {stadiamaps-3.2.1.dist-info → stadiamaps-5.0.0.dist-info}/top_level.txt +0 -0
stadiamaps/api/geocoding_api.py
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
|
7
7
|
|
8
|
-
The version of the OpenAPI document:
|
8
|
+
The version of the OpenAPI document: 8.0.0
|
9
9
|
Contact: support@stadiamaps.com
|
10
10
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
11
11
|
|
@@ -22,9 +22,9 @@ from typing import List, Optional, Union
|
|
22
22
|
from typing_extensions import Annotated
|
23
23
|
from stadiamaps.models.bulk_request import BulkRequest
|
24
24
|
from stadiamaps.models.bulk_search_response import BulkSearchResponse
|
25
|
-
from stadiamaps.models.
|
26
|
-
from stadiamaps.models.
|
27
|
-
from stadiamaps.models.
|
25
|
+
from stadiamaps.models.geocode_response import GeocodeResponse
|
26
|
+
from stadiamaps.models.geocoding_layer import GeocodingLayer
|
27
|
+
from stadiamaps.models.geocoding_source import GeocodingSource
|
28
28
|
|
29
29
|
from stadiamaps.api_client import ApiClient, RequestSerialized
|
30
30
|
from stadiamaps.api_response import ApiResponse
|
@@ -58,9 +58,9 @@ class GeocodingApi:
|
|
58
58
|
boundary_circle_lon: Annotated[Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]], Field(description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.")] = None,
|
59
59
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
60
60
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
61
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
62
|
-
layers: Annotated[Optional[List[
|
63
|
-
sources: Annotated[Optional[List[
|
61
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
62
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
63
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
64
64
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
65
65
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
66
66
|
_request_timeout: Union[
|
@@ -75,7 +75,7 @@ class GeocodingApi:
|
|
75
75
|
_content_type: Optional[StrictStr] = None,
|
76
76
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
77
77
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
78
|
-
) ->
|
78
|
+
) -> GeocodeResponse:
|
79
79
|
"""Search and geocode quickly based on partial input.
|
80
80
|
|
81
81
|
Autocomplete enables interactive search-as-you-type user experiences, suggesting places as you type, along with information that will help your users find the correct place quickly.
|
@@ -102,12 +102,12 @@ class GeocodingApi:
|
|
102
102
|
:type boundary_circle_radius: float
|
103
103
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
104
104
|
:type boundary_country: List[str]
|
105
|
-
:param boundary_gid: The
|
105
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
106
106
|
:type boundary_gid: str
|
107
107
|
:param layers: A list of layers to limit the search to.
|
108
|
-
:type layers: List[
|
108
|
+
:type layers: List[GeocodingLayer]
|
109
109
|
:param sources: A list of sources to limit the search to.
|
110
|
-
:type sources: List[
|
110
|
+
:type sources: List[GeocodingSource]
|
111
111
|
:param size: The maximum number of results to return.
|
112
112
|
:type size: int
|
113
113
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
@@ -158,7 +158,7 @@ class GeocodingApi:
|
|
158
158
|
)
|
159
159
|
|
160
160
|
_response_types_map: Dict[str, Optional[str]] = {
|
161
|
-
'200': "
|
161
|
+
'200': "GeocodeResponse",
|
162
162
|
'400': None,
|
163
163
|
}
|
164
164
|
response_data = self.api_client.call_api(
|
@@ -186,9 +186,9 @@ class GeocodingApi:
|
|
186
186
|
boundary_circle_lon: Annotated[Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]], Field(description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.")] = None,
|
187
187
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
188
188
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
189
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
190
|
-
layers: Annotated[Optional[List[
|
191
|
-
sources: Annotated[Optional[List[
|
189
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
190
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
191
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
192
192
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
193
193
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
194
194
|
_request_timeout: Union[
|
@@ -203,7 +203,7 @@ class GeocodingApi:
|
|
203
203
|
_content_type: Optional[StrictStr] = None,
|
204
204
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
205
205
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
206
|
-
) -> ApiResponse[
|
206
|
+
) -> ApiResponse[GeocodeResponse]:
|
207
207
|
"""Search and geocode quickly based on partial input.
|
208
208
|
|
209
209
|
Autocomplete enables interactive search-as-you-type user experiences, suggesting places as you type, along with information that will help your users find the correct place quickly.
|
@@ -230,12 +230,12 @@ class GeocodingApi:
|
|
230
230
|
:type boundary_circle_radius: float
|
231
231
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
232
232
|
:type boundary_country: List[str]
|
233
|
-
:param boundary_gid: The
|
233
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
234
234
|
:type boundary_gid: str
|
235
235
|
:param layers: A list of layers to limit the search to.
|
236
|
-
:type layers: List[
|
236
|
+
:type layers: List[GeocodingLayer]
|
237
237
|
:param sources: A list of sources to limit the search to.
|
238
|
-
:type sources: List[
|
238
|
+
:type sources: List[GeocodingSource]
|
239
239
|
:param size: The maximum number of results to return.
|
240
240
|
:type size: int
|
241
241
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
@@ -286,7 +286,7 @@ class GeocodingApi:
|
|
286
286
|
)
|
287
287
|
|
288
288
|
_response_types_map: Dict[str, Optional[str]] = {
|
289
|
-
'200': "
|
289
|
+
'200': "GeocodeResponse",
|
290
290
|
'400': None,
|
291
291
|
}
|
292
292
|
response_data = self.api_client.call_api(
|
@@ -314,9 +314,9 @@ class GeocodingApi:
|
|
314
314
|
boundary_circle_lon: Annotated[Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]], Field(description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.")] = None,
|
315
315
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
316
316
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
317
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
318
|
-
layers: Annotated[Optional[List[
|
319
|
-
sources: Annotated[Optional[List[
|
317
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
318
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
319
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
320
320
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
321
321
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
322
322
|
_request_timeout: Union[
|
@@ -358,12 +358,12 @@ class GeocodingApi:
|
|
358
358
|
:type boundary_circle_radius: float
|
359
359
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
360
360
|
:type boundary_country: List[str]
|
361
|
-
:param boundary_gid: The
|
361
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
362
362
|
:type boundary_gid: str
|
363
363
|
:param layers: A list of layers to limit the search to.
|
364
|
-
:type layers: List[
|
364
|
+
:type layers: List[GeocodingLayer]
|
365
365
|
:param sources: A list of sources to limit the search to.
|
366
|
-
:type sources: List[
|
366
|
+
:type sources: List[GeocodingSource]
|
367
367
|
:param size: The maximum number of results to return.
|
368
368
|
:type size: int
|
369
369
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
@@ -414,7 +414,7 @@ class GeocodingApi:
|
|
414
414
|
)
|
415
415
|
|
416
416
|
_response_types_map: Dict[str, Optional[str]] = {
|
417
|
-
'200': "
|
417
|
+
'200': "GeocodeResponse",
|
418
418
|
'400': None,
|
419
419
|
}
|
420
420
|
response_data = self.api_client.call_api(
|
@@ -460,7 +460,9 @@ class GeocodingApi:
|
|
460
460
|
_query_params: List[Tuple[str, str]] = []
|
461
461
|
_header_params: Dict[str, Optional[str]] = _headers or {}
|
462
462
|
_form_params: List[Tuple[str, str]] = []
|
463
|
-
_files: Dict[
|
463
|
+
_files: Dict[
|
464
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
465
|
+
] = {}
|
464
466
|
_body_params: Optional[bytes] = None
|
465
467
|
|
466
468
|
# process the path parameters
|
@@ -569,7 +571,7 @@ class GeocodingApi:
|
|
569
571
|
@validate_call
|
570
572
|
def place(
|
571
573
|
self,
|
572
|
-
ids: Annotated[List[StrictStr], Field(description="A list of
|
574
|
+
ids: Annotated[List[StrictStr], Field(description="A list of GIDs to search for.")],
|
573
575
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
574
576
|
_request_timeout: Union[
|
575
577
|
None,
|
@@ -583,12 +585,12 @@ class GeocodingApi:
|
|
583
585
|
_content_type: Optional[StrictStr] = None,
|
584
586
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
585
587
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
586
|
-
) ->
|
588
|
+
) -> GeocodeResponse:
|
587
589
|
"""Retrieve details of a place using its GID.
|
588
590
|
|
589
|
-
Many search result components include an associated GID field (for example, an address may have a `localadmin_gid`). The place endpoint lets you look up these places directly by ID. Note that
|
591
|
+
Many search result components include an associated GID field (for example, an address may have a `localadmin_gid`). The place endpoint lets you look up these places directly by ID. Note that GIDs are not stable for all sources. See the [online documentation](https://docs.stadiamaps.com/geocoding-search-autocomplete/place-lookup/) for details.
|
590
592
|
|
591
|
-
:param ids: A list of
|
593
|
+
:param ids: A list of GIDs to search for. (required)
|
592
594
|
:type ids: List[str]
|
593
595
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
594
596
|
:type lang: str
|
@@ -624,7 +626,7 @@ class GeocodingApi:
|
|
624
626
|
)
|
625
627
|
|
626
628
|
_response_types_map: Dict[str, Optional[str]] = {
|
627
|
-
'200': "
|
629
|
+
'200': "GeocodeResponse",
|
628
630
|
'400': None,
|
629
631
|
}
|
630
632
|
response_data = self.api_client.call_api(
|
@@ -641,7 +643,7 @@ class GeocodingApi:
|
|
641
643
|
@validate_call
|
642
644
|
def place_with_http_info(
|
643
645
|
self,
|
644
|
-
ids: Annotated[List[StrictStr], Field(description="A list of
|
646
|
+
ids: Annotated[List[StrictStr], Field(description="A list of GIDs to search for.")],
|
645
647
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
646
648
|
_request_timeout: Union[
|
647
649
|
None,
|
@@ -655,12 +657,12 @@ class GeocodingApi:
|
|
655
657
|
_content_type: Optional[StrictStr] = None,
|
656
658
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
657
659
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
658
|
-
) -> ApiResponse[
|
660
|
+
) -> ApiResponse[GeocodeResponse]:
|
659
661
|
"""Retrieve details of a place using its GID.
|
660
662
|
|
661
|
-
Many search result components include an associated GID field (for example, an address may have a `localadmin_gid`). The place endpoint lets you look up these places directly by ID. Note that
|
663
|
+
Many search result components include an associated GID field (for example, an address may have a `localadmin_gid`). The place endpoint lets you look up these places directly by ID. Note that GIDs are not stable for all sources. See the [online documentation](https://docs.stadiamaps.com/geocoding-search-autocomplete/place-lookup/) for details.
|
662
664
|
|
663
|
-
:param ids: A list of
|
665
|
+
:param ids: A list of GIDs to search for. (required)
|
664
666
|
:type ids: List[str]
|
665
667
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
666
668
|
:type lang: str
|
@@ -696,7 +698,7 @@ class GeocodingApi:
|
|
696
698
|
)
|
697
699
|
|
698
700
|
_response_types_map: Dict[str, Optional[str]] = {
|
699
|
-
'200': "
|
701
|
+
'200': "GeocodeResponse",
|
700
702
|
'400': None,
|
701
703
|
}
|
702
704
|
response_data = self.api_client.call_api(
|
@@ -713,7 +715,7 @@ class GeocodingApi:
|
|
713
715
|
@validate_call
|
714
716
|
def place_without_preload_content(
|
715
717
|
self,
|
716
|
-
ids: Annotated[List[StrictStr], Field(description="A list of
|
718
|
+
ids: Annotated[List[StrictStr], Field(description="A list of GIDs to search for.")],
|
717
719
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
718
720
|
_request_timeout: Union[
|
719
721
|
None,
|
@@ -730,9 +732,9 @@ class GeocodingApi:
|
|
730
732
|
) -> RESTResponseType:
|
731
733
|
"""Retrieve details of a place using its GID.
|
732
734
|
|
733
|
-
Many search result components include an associated GID field (for example, an address may have a `localadmin_gid`). The place endpoint lets you look up these places directly by ID. Note that
|
735
|
+
Many search result components include an associated GID field (for example, an address may have a `localadmin_gid`). The place endpoint lets you look up these places directly by ID. Note that GIDs are not stable for all sources. See the [online documentation](https://docs.stadiamaps.com/geocoding-search-autocomplete/place-lookup/) for details.
|
734
736
|
|
735
|
-
:param ids: A list of
|
737
|
+
:param ids: A list of GIDs to search for. (required)
|
736
738
|
:type ids: List[str]
|
737
739
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
738
740
|
:type lang: str
|
@@ -768,7 +770,7 @@ class GeocodingApi:
|
|
768
770
|
)
|
769
771
|
|
770
772
|
_response_types_map: Dict[str, Optional[str]] = {
|
771
|
-
'200': "
|
773
|
+
'200': "GeocodeResponse",
|
772
774
|
'400': None,
|
773
775
|
}
|
774
776
|
response_data = self.api_client.call_api(
|
@@ -798,7 +800,9 @@ class GeocodingApi:
|
|
798
800
|
_query_params: List[Tuple[str, str]] = []
|
799
801
|
_header_params: Dict[str, Optional[str]] = _headers or {}
|
800
802
|
_form_params: List[Tuple[str, str]] = []
|
801
|
-
_files: Dict[
|
803
|
+
_files: Dict[
|
804
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
805
|
+
] = {}
|
802
806
|
_body_params: Optional[bytes] = None
|
803
807
|
|
804
808
|
# process the path parameters
|
@@ -854,10 +858,10 @@ class GeocodingApi:
|
|
854
858
|
point_lat: Annotated[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]], Field(description="The latitude of the point at which to perform the search.")],
|
855
859
|
point_lon: Annotated[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]], Field(description="The longitude of the point at which to perform the search.")],
|
856
860
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
857
|
-
layers: Annotated[Optional[List[
|
858
|
-
sources: Annotated[Optional[List[
|
861
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
862
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
859
863
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
860
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
864
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
861
865
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
862
866
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
863
867
|
_request_timeout: Union[
|
@@ -872,7 +876,7 @@ class GeocodingApi:
|
|
872
876
|
_content_type: Optional[StrictStr] = None,
|
873
877
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
874
878
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
875
|
-
) ->
|
879
|
+
) -> GeocodeResponse:
|
876
880
|
"""Find places and addresses near geographic coordinates (reverse geocoding).
|
877
881
|
|
878
882
|
Reverse geocoding and search finds places and addresses near any geographic coordinates.
|
@@ -884,12 +888,12 @@ class GeocodingApi:
|
|
884
888
|
:param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
|
885
889
|
:type boundary_circle_radius: float
|
886
890
|
:param layers: A list of layers to limit the search to.
|
887
|
-
:type layers: List[
|
891
|
+
:type layers: List[GeocodingLayer]
|
888
892
|
:param sources: A list of sources to limit the search to.
|
889
|
-
:type sources: List[
|
893
|
+
:type sources: List[GeocodingSource]
|
890
894
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
891
895
|
:type boundary_country: List[str]
|
892
|
-
:param boundary_gid: The
|
896
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
893
897
|
:type boundary_gid: str
|
894
898
|
:param size: The maximum number of results to return.
|
895
899
|
:type size: int
|
@@ -934,7 +938,7 @@ class GeocodingApi:
|
|
934
938
|
)
|
935
939
|
|
936
940
|
_response_types_map: Dict[str, Optional[str]] = {
|
937
|
-
'200': "
|
941
|
+
'200': "GeocodeResponse",
|
938
942
|
'400': None,
|
939
943
|
}
|
940
944
|
response_data = self.api_client.call_api(
|
@@ -954,10 +958,10 @@ class GeocodingApi:
|
|
954
958
|
point_lat: Annotated[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]], Field(description="The latitude of the point at which to perform the search.")],
|
955
959
|
point_lon: Annotated[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]], Field(description="The longitude of the point at which to perform the search.")],
|
956
960
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
957
|
-
layers: Annotated[Optional[List[
|
958
|
-
sources: Annotated[Optional[List[
|
961
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
962
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
959
963
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
960
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
964
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
961
965
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
962
966
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
963
967
|
_request_timeout: Union[
|
@@ -972,7 +976,7 @@ class GeocodingApi:
|
|
972
976
|
_content_type: Optional[StrictStr] = None,
|
973
977
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
974
978
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
975
|
-
) -> ApiResponse[
|
979
|
+
) -> ApiResponse[GeocodeResponse]:
|
976
980
|
"""Find places and addresses near geographic coordinates (reverse geocoding).
|
977
981
|
|
978
982
|
Reverse geocoding and search finds places and addresses near any geographic coordinates.
|
@@ -984,12 +988,12 @@ class GeocodingApi:
|
|
984
988
|
:param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
|
985
989
|
:type boundary_circle_radius: float
|
986
990
|
:param layers: A list of layers to limit the search to.
|
987
|
-
:type layers: List[
|
991
|
+
:type layers: List[GeocodingLayer]
|
988
992
|
:param sources: A list of sources to limit the search to.
|
989
|
-
:type sources: List[
|
993
|
+
:type sources: List[GeocodingSource]
|
990
994
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
991
995
|
:type boundary_country: List[str]
|
992
|
-
:param boundary_gid: The
|
996
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
993
997
|
:type boundary_gid: str
|
994
998
|
:param size: The maximum number of results to return.
|
995
999
|
:type size: int
|
@@ -1034,7 +1038,7 @@ class GeocodingApi:
|
|
1034
1038
|
)
|
1035
1039
|
|
1036
1040
|
_response_types_map: Dict[str, Optional[str]] = {
|
1037
|
-
'200': "
|
1041
|
+
'200': "GeocodeResponse",
|
1038
1042
|
'400': None,
|
1039
1043
|
}
|
1040
1044
|
response_data = self.api_client.call_api(
|
@@ -1054,10 +1058,10 @@ class GeocodingApi:
|
|
1054
1058
|
point_lat: Annotated[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]], Field(description="The latitude of the point at which to perform the search.")],
|
1055
1059
|
point_lon: Annotated[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]], Field(description="The longitude of the point at which to perform the search.")],
|
1056
1060
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
1057
|
-
layers: Annotated[Optional[List[
|
1058
|
-
sources: Annotated[Optional[List[
|
1061
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
1062
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
1059
1063
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
1060
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
1064
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
1061
1065
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
1062
1066
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
1063
1067
|
_request_timeout: Union[
|
@@ -1084,12 +1088,12 @@ class GeocodingApi:
|
|
1084
1088
|
:param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
|
1085
1089
|
:type boundary_circle_radius: float
|
1086
1090
|
:param layers: A list of layers to limit the search to.
|
1087
|
-
:type layers: List[
|
1091
|
+
:type layers: List[GeocodingLayer]
|
1088
1092
|
:param sources: A list of sources to limit the search to.
|
1089
|
-
:type sources: List[
|
1093
|
+
:type sources: List[GeocodingSource]
|
1090
1094
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
1091
1095
|
:type boundary_country: List[str]
|
1092
|
-
:param boundary_gid: The
|
1096
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
1093
1097
|
:type boundary_gid: str
|
1094
1098
|
:param size: The maximum number of results to return.
|
1095
1099
|
:type size: int
|
@@ -1134,7 +1138,7 @@ class GeocodingApi:
|
|
1134
1138
|
)
|
1135
1139
|
|
1136
1140
|
_response_types_map: Dict[str, Optional[str]] = {
|
1137
|
-
'200': "
|
1141
|
+
'200': "GeocodeResponse",
|
1138
1142
|
'400': None,
|
1139
1143
|
}
|
1140
1144
|
response_data = self.api_client.call_api(
|
@@ -1173,7 +1177,9 @@ class GeocodingApi:
|
|
1173
1177
|
_query_params: List[Tuple[str, str]] = []
|
1174
1178
|
_header_params: Dict[str, Optional[str]] = _headers or {}
|
1175
1179
|
_form_params: List[Tuple[str, str]] = []
|
1176
|
-
_files: Dict[
|
1180
|
+
_files: Dict[
|
1181
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
1182
|
+
] = {}
|
1177
1183
|
_body_params: Optional[bytes] = None
|
1178
1184
|
|
1179
1185
|
# process the path parameters
|
@@ -1265,9 +1271,9 @@ class GeocodingApi:
|
|
1265
1271
|
boundary_circle_lon: Annotated[Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]], Field(description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.")] = None,
|
1266
1272
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
1267
1273
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
1268
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
1269
|
-
layers: Annotated[Optional[List[
|
1270
|
-
sources: Annotated[Optional[List[
|
1274
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
1275
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
1276
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
1271
1277
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
1272
1278
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
1273
1279
|
_request_timeout: Union[
|
@@ -1282,7 +1288,7 @@ class GeocodingApi:
|
|
1282
1288
|
_content_type: Optional[StrictStr] = None,
|
1283
1289
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1284
1290
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1285
|
-
) ->
|
1291
|
+
) -> GeocodeResponse:
|
1286
1292
|
"""Search for location and other info using a place name or address (forward geocoding).
|
1287
1293
|
|
1288
1294
|
The search endpoint lets you search for addresses, points of interest, and administrative areas. This is most commonly used for forward geocoding applications where you need to find the geographic coordinates of an address.
|
@@ -1309,12 +1315,12 @@ class GeocodingApi:
|
|
1309
1315
|
:type boundary_circle_radius: float
|
1310
1316
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
1311
1317
|
:type boundary_country: List[str]
|
1312
|
-
:param boundary_gid: The
|
1318
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
1313
1319
|
:type boundary_gid: str
|
1314
1320
|
:param layers: A list of layers to limit the search to.
|
1315
|
-
:type layers: List[
|
1321
|
+
:type layers: List[GeocodingLayer]
|
1316
1322
|
:param sources: A list of sources to limit the search to.
|
1317
|
-
:type sources: List[
|
1323
|
+
:type sources: List[GeocodingSource]
|
1318
1324
|
:param size: The maximum number of results to return.
|
1319
1325
|
:type size: int
|
1320
1326
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
@@ -1365,7 +1371,7 @@ class GeocodingApi:
|
|
1365
1371
|
)
|
1366
1372
|
|
1367
1373
|
_response_types_map: Dict[str, Optional[str]] = {
|
1368
|
-
'200': "
|
1374
|
+
'200': "GeocodeResponse",
|
1369
1375
|
'400': None,
|
1370
1376
|
}
|
1371
1377
|
response_data = self.api_client.call_api(
|
@@ -1393,9 +1399,9 @@ class GeocodingApi:
|
|
1393
1399
|
boundary_circle_lon: Annotated[Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]], Field(description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.")] = None,
|
1394
1400
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
1395
1401
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
1396
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
1397
|
-
layers: Annotated[Optional[List[
|
1398
|
-
sources: Annotated[Optional[List[
|
1402
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
1403
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
1404
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
1399
1405
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
1400
1406
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
1401
1407
|
_request_timeout: Union[
|
@@ -1410,7 +1416,7 @@ class GeocodingApi:
|
|
1410
1416
|
_content_type: Optional[StrictStr] = None,
|
1411
1417
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
1412
1418
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
1413
|
-
) -> ApiResponse[
|
1419
|
+
) -> ApiResponse[GeocodeResponse]:
|
1414
1420
|
"""Search for location and other info using a place name or address (forward geocoding).
|
1415
1421
|
|
1416
1422
|
The search endpoint lets you search for addresses, points of interest, and administrative areas. This is most commonly used for forward geocoding applications where you need to find the geographic coordinates of an address.
|
@@ -1437,12 +1443,12 @@ class GeocodingApi:
|
|
1437
1443
|
:type boundary_circle_radius: float
|
1438
1444
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
1439
1445
|
:type boundary_country: List[str]
|
1440
|
-
:param boundary_gid: The
|
1446
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
1441
1447
|
:type boundary_gid: str
|
1442
1448
|
:param layers: A list of layers to limit the search to.
|
1443
|
-
:type layers: List[
|
1449
|
+
:type layers: List[GeocodingLayer]
|
1444
1450
|
:param sources: A list of sources to limit the search to.
|
1445
|
-
:type sources: List[
|
1451
|
+
:type sources: List[GeocodingSource]
|
1446
1452
|
:param size: The maximum number of results to return.
|
1447
1453
|
:type size: int
|
1448
1454
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
@@ -1493,7 +1499,7 @@ class GeocodingApi:
|
|
1493
1499
|
)
|
1494
1500
|
|
1495
1501
|
_response_types_map: Dict[str, Optional[str]] = {
|
1496
|
-
'200': "
|
1502
|
+
'200': "GeocodeResponse",
|
1497
1503
|
'400': None,
|
1498
1504
|
}
|
1499
1505
|
response_data = self.api_client.call_api(
|
@@ -1521,9 +1527,9 @@ class GeocodingApi:
|
|
1521
1527
|
boundary_circle_lon: Annotated[Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]], Field(description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.")] = None,
|
1522
1528
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
1523
1529
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
1524
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
1525
|
-
layers: Annotated[Optional[List[
|
1526
|
-
sources: Annotated[Optional[List[
|
1530
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
1531
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
1532
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
1527
1533
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
1528
1534
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
1529
1535
|
_request_timeout: Union[
|
@@ -1565,12 +1571,12 @@ class GeocodingApi:
|
|
1565
1571
|
:type boundary_circle_radius: float
|
1566
1572
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
1567
1573
|
:type boundary_country: List[str]
|
1568
|
-
:param boundary_gid: The
|
1574
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
1569
1575
|
:type boundary_gid: str
|
1570
1576
|
:param layers: A list of layers to limit the search to.
|
1571
|
-
:type layers: List[
|
1577
|
+
:type layers: List[GeocodingLayer]
|
1572
1578
|
:param sources: A list of sources to limit the search to.
|
1573
|
-
:type sources: List[
|
1579
|
+
:type sources: List[GeocodingSource]
|
1574
1580
|
:param size: The maximum number of results to return.
|
1575
1581
|
:type size: int
|
1576
1582
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
@@ -1621,7 +1627,7 @@ class GeocodingApi:
|
|
1621
1627
|
)
|
1622
1628
|
|
1623
1629
|
_response_types_map: Dict[str, Optional[str]] = {
|
1624
|
-
'200': "
|
1630
|
+
'200': "GeocodeResponse",
|
1625
1631
|
'400': None,
|
1626
1632
|
}
|
1627
1633
|
response_data = self.api_client.call_api(
|
@@ -1667,7 +1673,9 @@ class GeocodingApi:
|
|
1667
1673
|
_query_params: List[Tuple[str, str]] = []
|
1668
1674
|
_header_params: Dict[str, Optional[str]] = _headers or {}
|
1669
1675
|
_form_params: List[Tuple[str, str]] = []
|
1670
|
-
_files: Dict[
|
1676
|
+
_files: Dict[
|
1677
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
1678
|
+
] = {}
|
1671
1679
|
_body_params: Optional[bytes] = None
|
1672
1680
|
|
1673
1681
|
# process the path parameters
|
@@ -1992,7 +2000,9 @@ class GeocodingApi:
|
|
1992
2000
|
_query_params: List[Tuple[str, str]] = []
|
1993
2001
|
_header_params: Dict[str, Optional[str]] = _headers or {}
|
1994
2002
|
_form_params: List[Tuple[str, str]] = []
|
1995
|
-
_files: Dict[
|
2003
|
+
_files: Dict[
|
2004
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
2005
|
+
] = {}
|
1996
2006
|
_body_params: Optional[bytes] = None
|
1997
2007
|
|
1998
2008
|
# process the path parameters
|
@@ -2070,9 +2080,9 @@ class GeocodingApi:
|
|
2070
2080
|
boundary_circle_lon: Annotated[Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]], Field(description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.")] = None,
|
2071
2081
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
2072
2082
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
2073
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
2074
|
-
layers: Annotated[Optional[List[
|
2075
|
-
sources: Annotated[Optional[List[
|
2083
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
2084
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
2085
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
2076
2086
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
2077
2087
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
2078
2088
|
_request_timeout: Union[
|
@@ -2087,7 +2097,7 @@ class GeocodingApi:
|
|
2087
2097
|
_content_type: Optional[StrictStr] = None,
|
2088
2098
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
2089
2099
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
2090
|
-
) ->
|
2100
|
+
) -> GeocodeResponse:
|
2091
2101
|
"""Find locations matching components (structured forward geocoding).
|
2092
2102
|
|
2093
2103
|
The structured search endpoint lets you search for addresses, points of interest, and administrative areas. Rather than a single string which the API must infer meaning from, the structured search endpoint allows you to specify the known components upfront, which is useful in many forward geocoding workflows.
|
@@ -2128,12 +2138,12 @@ class GeocodingApi:
|
|
2128
2138
|
:type boundary_circle_radius: float
|
2129
2139
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
2130
2140
|
:type boundary_country: List[str]
|
2131
|
-
:param boundary_gid: The
|
2141
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
2132
2142
|
:type boundary_gid: str
|
2133
2143
|
:param layers: A list of layers to limit the search to.
|
2134
|
-
:type layers: List[
|
2144
|
+
:type layers: List[GeocodingLayer]
|
2135
2145
|
:param sources: A list of sources to limit the search to.
|
2136
|
-
:type sources: List[
|
2146
|
+
:type sources: List[GeocodingSource]
|
2137
2147
|
:param size: The maximum number of results to return.
|
2138
2148
|
:type size: int
|
2139
2149
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
@@ -2191,7 +2201,7 @@ class GeocodingApi:
|
|
2191
2201
|
)
|
2192
2202
|
|
2193
2203
|
_response_types_map: Dict[str, Optional[str]] = {
|
2194
|
-
'200': "
|
2204
|
+
'200': "GeocodeResponse",
|
2195
2205
|
'400': None,
|
2196
2206
|
}
|
2197
2207
|
response_data = self.api_client.call_api(
|
@@ -2226,9 +2236,9 @@ class GeocodingApi:
|
|
2226
2236
|
boundary_circle_lon: Annotated[Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]], Field(description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.")] = None,
|
2227
2237
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
2228
2238
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
2229
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
2230
|
-
layers: Annotated[Optional[List[
|
2231
|
-
sources: Annotated[Optional[List[
|
2239
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
2240
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
2241
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
2232
2242
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
2233
2243
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
2234
2244
|
_request_timeout: Union[
|
@@ -2243,7 +2253,7 @@ class GeocodingApi:
|
|
2243
2253
|
_content_type: Optional[StrictStr] = None,
|
2244
2254
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
2245
2255
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
2246
|
-
) -> ApiResponse[
|
2256
|
+
) -> ApiResponse[GeocodeResponse]:
|
2247
2257
|
"""Find locations matching components (structured forward geocoding).
|
2248
2258
|
|
2249
2259
|
The structured search endpoint lets you search for addresses, points of interest, and administrative areas. Rather than a single string which the API must infer meaning from, the structured search endpoint allows you to specify the known components upfront, which is useful in many forward geocoding workflows.
|
@@ -2284,12 +2294,12 @@ class GeocodingApi:
|
|
2284
2294
|
:type boundary_circle_radius: float
|
2285
2295
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
2286
2296
|
:type boundary_country: List[str]
|
2287
|
-
:param boundary_gid: The
|
2297
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
2288
2298
|
:type boundary_gid: str
|
2289
2299
|
:param layers: A list of layers to limit the search to.
|
2290
|
-
:type layers: List[
|
2300
|
+
:type layers: List[GeocodingLayer]
|
2291
2301
|
:param sources: A list of sources to limit the search to.
|
2292
|
-
:type sources: List[
|
2302
|
+
:type sources: List[GeocodingSource]
|
2293
2303
|
:param size: The maximum number of results to return.
|
2294
2304
|
:type size: int
|
2295
2305
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
@@ -2347,7 +2357,7 @@ class GeocodingApi:
|
|
2347
2357
|
)
|
2348
2358
|
|
2349
2359
|
_response_types_map: Dict[str, Optional[str]] = {
|
2350
|
-
'200': "
|
2360
|
+
'200': "GeocodeResponse",
|
2351
2361
|
'400': None,
|
2352
2362
|
}
|
2353
2363
|
response_data = self.api_client.call_api(
|
@@ -2382,9 +2392,9 @@ class GeocodingApi:
|
|
2382
2392
|
boundary_circle_lon: Annotated[Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]], Field(description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.")] = None,
|
2383
2393
|
boundary_circle_radius: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.")] = None,
|
2384
2394
|
boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.")] = None,
|
2385
|
-
boundary_gid: Annotated[Optional[StrictStr], Field(description="The
|
2386
|
-
layers: Annotated[Optional[List[
|
2387
|
-
sources: Annotated[Optional[List[
|
2395
|
+
boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
|
2396
|
+
layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
|
2397
|
+
sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
|
2388
2398
|
size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
|
2389
2399
|
lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")] = None,
|
2390
2400
|
_request_timeout: Union[
|
@@ -2440,12 +2450,12 @@ class GeocodingApi:
|
|
2440
2450
|
:type boundary_circle_radius: float
|
2441
2451
|
:param boundary_country: A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible.
|
2442
2452
|
:type boundary_country: List[str]
|
2443
|
-
:param boundary_gid: The
|
2453
|
+
:param boundary_gid: The GID of an area to limit the search to.
|
2444
2454
|
:type boundary_gid: str
|
2445
2455
|
:param layers: A list of layers to limit the search to.
|
2446
|
-
:type layers: List[
|
2456
|
+
:type layers: List[GeocodingLayer]
|
2447
2457
|
:param sources: A list of sources to limit the search to.
|
2448
|
-
:type sources: List[
|
2458
|
+
:type sources: List[GeocodingSource]
|
2449
2459
|
:param size: The maximum number of results to return.
|
2450
2460
|
:type size: int
|
2451
2461
|
:param lang: A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
|
@@ -2503,7 +2513,7 @@ class GeocodingApi:
|
|
2503
2513
|
)
|
2504
2514
|
|
2505
2515
|
_response_types_map: Dict[str, Optional[str]] = {
|
2506
|
-
'200': "
|
2516
|
+
'200': "GeocodeResponse",
|
2507
2517
|
'400': None,
|
2508
2518
|
}
|
2509
2519
|
response_data = self.api_client.call_api(
|
@@ -2556,7 +2566,9 @@ class GeocodingApi:
|
|
2556
2566
|
_query_params: List[Tuple[str, str]] = []
|
2557
2567
|
_header_params: Dict[str, Optional[str]] = _headers or {}
|
2558
2568
|
_form_params: List[Tuple[str, str]] = []
|
2559
|
-
_files: Dict[
|
2569
|
+
_files: Dict[
|
2570
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
2571
|
+
] = {}
|
2560
2572
|
_body_params: Optional[bytes] = None
|
2561
2573
|
|
2562
2574
|
# process the path parameters
|