stadiamaps 5.0.0__py3-none-any.whl → 6.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.
Files changed (158) hide show
  1. stadiamaps/__init__.py +23 -5
  2. stadiamaps/api/geocoding_api.py +849 -38
  3. stadiamaps/api/geospatial_api.py +1 -1
  4. stadiamaps/api/routing_api.py +1 -1
  5. stadiamaps/api_client.py +3 -3
  6. stadiamaps/configuration.py +5 -5
  7. stadiamaps/exceptions.py +18 -1
  8. stadiamaps/models/__init__.py +22 -4
  9. stadiamaps/models/access.py +1 -1
  10. stadiamaps/models/addendum_v2.py +143 -0
  11. stadiamaps/models/address_components_v2.py +134 -0
  12. stadiamaps/models/admin_region.py +1 -1
  13. stadiamaps/models/administrative.py +1 -1
  14. stadiamaps/models/annotation_filters.py +1 -1
  15. stadiamaps/models/auto_costing_options.py +1 -1
  16. stadiamaps/models/base_costing_options.py +1 -1
  17. stadiamaps/models/base_trace_request.py +1 -1
  18. stadiamaps/models/bicycle_costing_options.py +1 -1
  19. stadiamaps/models/bike_network.py +1 -1
  20. stadiamaps/models/bulk_request.py +1 -1
  21. stadiamaps/models/bulk_request_query.py +1 -1
  22. stadiamaps/models/bulk_search_response.py +1 -1
  23. stadiamaps/models/context.py +119 -0
  24. stadiamaps/models/contour.py +1 -1
  25. stadiamaps/models/coordinate.py +1 -1
  26. stadiamaps/models/costing_model.py +1 -1
  27. stadiamaps/models/costing_options.py +1 -1
  28. stadiamaps/models/directions_options.py +1 -1
  29. stadiamaps/models/distance_unit.py +1 -1
  30. stadiamaps/models/edge_sign.py +1 -1
  31. stadiamaps/models/edge_use.py +1 -1
  32. stadiamaps/models/end_node.py +1 -1
  33. stadiamaps/models/extended_directions_options.py +1 -1
  34. stadiamaps/models/feature_properties_v2.py +126 -0
  35. stadiamaps/models/feature_properties_v2_properties.py +184 -0
  36. stadiamaps/models/foursquare_addendum.py +113 -0
  37. stadiamaps/models/geo_attributes.py +1 -1
  38. stadiamaps/models/geo_json_geometry_base.py +1 -1
  39. stadiamaps/models/geo_json_point.py +1 -1
  40. stadiamaps/models/geocode_response.py +1 -1
  41. stadiamaps/models/geocode_response_envelope_properties_v2.py +125 -0
  42. stadiamaps/models/geocoding_geo_json_feature.py +1 -1
  43. stadiamaps/models/geocoding_geo_json_properties.py +8 -6
  44. stadiamaps/models/geocoding_geo_json_properties_addendum.py +1 -1
  45. stadiamaps/models/geocoding_geo_json_properties_addendum_osm.py +1 -1
  46. stadiamaps/models/geocoding_layer.py +1 -1
  47. stadiamaps/models/geocoding_meta.py +108 -0
  48. stadiamaps/models/geocoding_object.py +1 -1
  49. stadiamaps/models/geocoding_source.py +1 -1
  50. stadiamaps/models/geonames_addendum.py +101 -0
  51. stadiamaps/models/height_request.py +1 -1
  52. stadiamaps/models/height_response.py +1 -1
  53. stadiamaps/models/highway_classification.py +1 -1
  54. stadiamaps/models/intersecting_edge.py +1 -1
  55. stadiamaps/models/isochrone_costing_model.py +1 -1
  56. stadiamaps/models/isochrone_feature.py +1 -1
  57. stadiamaps/models/isochrone_properties.py +1 -1
  58. stadiamaps/models/isochrone_request.py +1 -1
  59. stadiamaps/models/isochrone_response.py +1 -1
  60. stadiamaps/models/layer_id.py +57 -0
  61. stadiamaps/models/locate_detailed_edge.py +1 -1
  62. stadiamaps/models/locate_edge.py +1 -1
  63. stadiamaps/models/locate_edge_info.py +1 -1
  64. stadiamaps/models/locate_node.py +1 -1
  65. stadiamaps/models/locate_object.py +1 -1
  66. stadiamaps/models/low_speed_vehicle_costing_options.py +1 -1
  67. stadiamaps/models/maneuver_sign.py +1 -1
  68. stadiamaps/models/maneuver_sign_element.py +1 -1
  69. stadiamaps/models/map_match_costing_model.py +1 -1
  70. stadiamaps/models/map_match_request.py +1 -1
  71. stadiamaps/models/map_match_route_response.py +1 -1
  72. stadiamaps/models/map_match_trace_options.py +1 -1
  73. stadiamaps/models/map_match_waypoint.py +3 -3
  74. stadiamaps/models/match_type.py +39 -0
  75. stadiamaps/models/matched_point.py +1 -1
  76. stadiamaps/models/matrix_costing_model.py +1 -1
  77. stadiamaps/models/matrix_distance.py +1 -1
  78. stadiamaps/models/matrix_request.py +1 -1
  79. stadiamaps/models/matrix_response.py +1 -1
  80. stadiamaps/models/matrix_waypoint.py +1 -1
  81. stadiamaps/models/motor_scooter_costing_options.py +1 -1
  82. stadiamaps/models/motorcycle_costing_options.py +1 -1
  83. stadiamaps/models/nearest_roads_request.py +1 -1
  84. stadiamaps/models/node_id.py +1 -1
  85. stadiamaps/models/node_type.py +1 -1
  86. stadiamaps/models/open_street_map_addendum.py +162 -0
  87. stadiamaps/models/optimized_route_request.py +1 -1
  88. stadiamaps/models/osrm_admin.py +1 -1
  89. stadiamaps/models/osrm_annotation.py +1 -1
  90. stadiamaps/models/osrm_banner_component.py +1 -1
  91. stadiamaps/models/osrm_banner_content.py +1 -1
  92. stadiamaps/models/osrm_banner_instruction.py +1 -1
  93. stadiamaps/models/osrm_base_api_response.py +1 -1
  94. stadiamaps/models/osrm_guidance_modifier.py +1 -1
  95. stadiamaps/models/osrm_intersection.py +1 -1
  96. stadiamaps/models/osrm_lane.py +1 -1
  97. stadiamaps/models/osrm_route.py +1 -1
  98. stadiamaps/models/osrm_route_leg.py +1 -1
  99. stadiamaps/models/osrm_route_response.py +1 -1
  100. stadiamaps/models/osrm_route_step.py +1 -1
  101. stadiamaps/models/osrm_speed_limit.py +1 -1
  102. stadiamaps/models/osrm_step_maneuver.py +1 -1
  103. stadiamaps/models/osrm_via_waypoint.py +1 -1
  104. stadiamaps/models/osrm_voice_instruction.py +1 -1
  105. stadiamaps/models/osrm_waypoint.py +1 -1
  106. stadiamaps/models/pedestrian_costing_options.py +8 -5
  107. stadiamaps/models/pedestrian_type.py +39 -0
  108. stadiamaps/models/point.py +104 -0
  109. stadiamaps/models/precision.py +38 -0
  110. stadiamaps/models/properties_v2.py +184 -0
  111. stadiamaps/models/restrictions.py +11 -11
  112. stadiamaps/models/road_class.py +1 -1
  113. stadiamaps/models/route200_response.py +1 -1
  114. stadiamaps/models/route_leg.py +1 -1
  115. stadiamaps/models/route_maneuver.py +1 -1
  116. stadiamaps/models/route_request.py +1 -1
  117. stadiamaps/models/route_response.py +1 -1
  118. stadiamaps/models/route_response_alternates_inner.py +1 -1
  119. stadiamaps/models/route_summary.py +1 -1
  120. stadiamaps/models/route_trip.py +1 -1
  121. stadiamaps/models/routing_languages.py +1 -1
  122. stadiamaps/models/routing_long_units.py +1 -1
  123. stadiamaps/models/routing_response_waypoint.py +3 -3
  124. stadiamaps/models/routing_waypoint.py +3 -3
  125. stadiamaps/models/routing_waypoint_all_of_search_filter.py +1 -1
  126. stadiamaps/models/search_query.py +2 -2
  127. stadiamaps/models/search_structured_query.py +3 -3
  128. stadiamaps/models/simple_routing_waypoint.py +3 -3
  129. stadiamaps/models/source_attribution.py +110 -0
  130. stadiamaps/models/source_id.py +41 -0
  131. stadiamaps/models/speeds.py +1 -1
  132. stadiamaps/models/trace_attribute_filter_options.py +1 -1
  133. stadiamaps/models/trace_attribute_key.py +1 -1
  134. stadiamaps/models/trace_attributes_base_response.py +1 -1
  135. stadiamaps/models/trace_attributes_request.py +1 -1
  136. stadiamaps/models/trace_attributes_response.py +1 -6
  137. stadiamaps/models/trace_edge.py +2 -7
  138. stadiamaps/models/travel_mode.py +1 -1
  139. stadiamaps/models/traversability.py +1 -1
  140. stadiamaps/models/truck_costing_options.py +1 -1
  141. stadiamaps/models/tz_response.py +1 -1
  142. stadiamaps/models/warning.py +1 -1
  143. stadiamaps/models/whos_on_first_concordances.py +246 -0
  144. stadiamaps/models/wof_context.py +210 -0
  145. stadiamaps/models/wof_context_component.py +110 -0
  146. stadiamaps/rest.py +1 -1
  147. stadiamaps-6.0.0.dist-info/METADATA +117 -0
  148. stadiamaps-6.0.0.dist-info/RECORD +183 -0
  149. {stadiamaps-5.0.0.dist-info → stadiamaps-6.0.0.dist-info}/WHEEL +1 -1
  150. {stadiamaps-5.0.0.dist-info → stadiamaps-6.0.0.dist-info}/top_level.txt +1 -0
  151. test/integration/__init__.py +0 -0
  152. test/integration/test_eu_endpoint.py +21 -0
  153. test/integration/test_gecoding.py +112 -0
  154. test/integration/test_geospatial.py +43 -0
  155. test/integration/test_routing.py +282 -0
  156. stadiamaps-5.0.0.dist-info/METADATA +0 -87
  157. stadiamaps-5.0.0.dist-info/RECORD +0 -157
  158. {stadiamaps-5.0.0.dist-info → stadiamaps-6.0.0.dist-info/licenses}/LICENSE.txt +0 -0
@@ -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.0.0
8
+ The version of the OpenAPI document: 9.0.0
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -23,8 +23,11 @@ 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
25
  from stadiamaps.models.geocode_response import GeocodeResponse
26
+ from stadiamaps.models.geocode_response_envelope_properties_v2 import GeocodeResponseEnvelopePropertiesV2
26
27
  from stadiamaps.models.geocoding_layer import GeocodingLayer
27
28
  from stadiamaps.models.geocoding_source import GeocodingSource
29
+ from stadiamaps.models.layer_id import LayerId
30
+ from stadiamaps.models.source_id import SourceId
28
31
 
29
32
  from stadiamaps.api_client import ApiClient, RequestSerialized
30
33
  from stadiamaps.api_response import ApiResponse
@@ -57,7 +60,7 @@ class GeocodingApi:
57
60
  boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. Requires `boundary.circle.lon`.")] = None,
58
61
  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
62
  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
- 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,
63
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
61
64
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
62
65
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
63
66
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
@@ -100,7 +103,7 @@ class GeocodingApi:
100
103
  :type boundary_circle_lon: float
101
104
  :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
102
105
  :type boundary_circle_radius: float
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.
106
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
104
107
  :type boundary_country: List[str]
105
108
  :param boundary_gid: The GID of an area to limit the search to.
106
109
  :type boundary_gid: str
@@ -185,7 +188,7 @@ class GeocodingApi:
185
188
  boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. Requires `boundary.circle.lon`.")] = None,
186
189
  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
190
  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
- 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,
191
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
189
192
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
190
193
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
191
194
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
@@ -228,7 +231,7 @@ class GeocodingApi:
228
231
  :type boundary_circle_lon: float
229
232
  :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
230
233
  :type boundary_circle_radius: float
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.
234
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
232
235
  :type boundary_country: List[str]
233
236
  :param boundary_gid: The GID of an area to limit the search to.
234
237
  :type boundary_gid: str
@@ -313,7 +316,7 @@ class GeocodingApi:
313
316
  boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. Requires `boundary.circle.lon`.")] = None,
314
317
  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
318
  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
- 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,
319
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
317
320
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
318
321
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
319
322
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
@@ -356,7 +359,7 @@ class GeocodingApi:
356
359
  :type boundary_circle_lon: float
357
360
  :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
358
361
  :type boundary_circle_radius: float
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.
362
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
360
363
  :type boundary_country: List[str]
361
364
  :param boundary_gid: The GID of an area to limit the search to.
362
365
  :type boundary_gid: str
@@ -569,7 +572,531 @@ class GeocodingApi:
569
572
 
570
573
 
571
574
  @validate_call
572
- def place(
575
+ def autocomplete_v2(
576
+ self,
577
+ text: Annotated[StrictStr, Field(description="The text to search for (the start of an address, place name, etc.).")],
578
+ focus_point_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="The latitude of a focus point. If provided (along with longitude), the search results should be more locally relevant.")] = None,
579
+ focus_point_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 a focus point. If provided (along with longitude), the search results should be more locally relevant.")] = None,
580
+ layers: Annotated[Optional[List[LayerId]], Field(description="A list of layers to limit the search to.")] = None,
581
+ sources: Annotated[Optional[List[SourceId]], Field(description="A list of sources to limit the search to.")] = None,
582
+ boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of a region to limit the search to. Note: these are not stable for all datasets! For example, OSM features may be deleted and re-added with a new ID.")] = None,
583
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of comma-separated country codes in ISO 3116-1 alpha-2 or alpha-3 format. The search will be limited to these countries.")] = None,
584
+ boundary_rect_min_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="The minimum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
585
+ boundary_rect_min_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 minimum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
586
+ boundary_rect_max_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="The maximum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
587
+ boundary_rect_max_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 maximum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
588
+ boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.")] = None,
589
+ 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. NOTE: Requires boundary.circle.lon.")] = None,
590
+ boundary_circle_radius: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="The radius of the circle (in kilometers) to limit the search to. NOTE: Requires the other boundary.circle parameters to take effect. Defaults to 50km if unspecified.")] = None,
591
+ size: Annotated[Optional[Annotated[int, Field(le=25, strict=True, ge=1)]], Field(description="The maximum number of items to return from a query.")] = None,
592
+ lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.")] = None,
593
+ _request_timeout: Union[
594
+ None,
595
+ Annotated[StrictFloat, Field(gt=0)],
596
+ Tuple[
597
+ Annotated[StrictFloat, Field(gt=0)],
598
+ Annotated[StrictFloat, Field(gt=0)]
599
+ ]
600
+ ] = None,
601
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
602
+ _content_type: Optional[StrictStr] = None,
603
+ _headers: Optional[Dict[StrictStr, Any]] = None,
604
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
605
+ ) -> GeocodeResponseEnvelopePropertiesV2:
606
+ """autocomplete_v2
607
+
608
+
609
+ :param text: The text to search for (the start of an address, place name, etc.). (required)
610
+ :type text: str
611
+ :param focus_point_lat: The latitude of a focus point. If provided (along with longitude), the search results should be more locally relevant.
612
+ :type focus_point_lat: float
613
+ :param focus_point_lon: The longitude of a focus point. If provided (along with longitude), the search results should be more locally relevant.
614
+ :type focus_point_lon: float
615
+ :param layers: A list of layers to limit the search to.
616
+ :type layers: List[LayerId]
617
+ :param sources: A list of sources to limit the search to.
618
+ :type sources: List[SourceId]
619
+ :param boundary_gid: The GID of a region to limit the search to. Note: these are not stable for all datasets! For example, OSM features may be deleted and re-added with a new ID.
620
+ :type boundary_gid: str
621
+ :param boundary_country: A list of comma-separated country codes in ISO 3116-1 alpha-2 or alpha-3 format. The search will be limited to these countries.
622
+ :type boundary_country: List[str]
623
+ :param boundary_rect_min_lat: The minimum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
624
+ :type boundary_rect_min_lat: float
625
+ :param boundary_rect_min_lon: The minimum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
626
+ :type boundary_rect_min_lon: float
627
+ :param boundary_rect_max_lat: The maximum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
628
+ :type boundary_rect_max_lat: float
629
+ :param boundary_rect_max_lon: The maximum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
630
+ :type boundary_rect_max_lon: float
631
+ :param boundary_circle_lat: The latitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.
632
+ :type boundary_circle_lat: float
633
+ :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.
634
+ :type boundary_circle_lon: float
635
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. NOTE: Requires the other boundary.circle parameters to take effect. Defaults to 50km if unspecified.
636
+ :type boundary_circle_radius: int
637
+ :param size: The maximum number of items to return from a query.
638
+ :type size: int
639
+ :param lang: A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.
640
+ :type lang: str
641
+ :param _request_timeout: timeout setting for this request. If one
642
+ number provided, it will be total request
643
+ timeout. It can also be a pair (tuple) of
644
+ (connection, read) timeouts.
645
+ :type _request_timeout: int, tuple(int, int), optional
646
+ :param _request_auth: set to override the auth_settings for an a single
647
+ request; this effectively ignores the
648
+ authentication in the spec for a single request.
649
+ :type _request_auth: dict, optional
650
+ :param _content_type: force content-type for the request.
651
+ :type _content_type: str, Optional
652
+ :param _headers: set to override the headers for a single
653
+ request; this effectively ignores the headers
654
+ in the spec for a single request.
655
+ :type _headers: dict, optional
656
+ :param _host_index: set to override the host_index for a single
657
+ request; this effectively ignores the host_index
658
+ in the spec for a single request.
659
+ :type _host_index: int, optional
660
+ :return: Returns the result object.
661
+ """ # noqa: E501
662
+
663
+ _param = self._autocomplete_v2_serialize(
664
+ text=text,
665
+ focus_point_lat=focus_point_lat,
666
+ focus_point_lon=focus_point_lon,
667
+ layers=layers,
668
+ sources=sources,
669
+ boundary_gid=boundary_gid,
670
+ boundary_country=boundary_country,
671
+ boundary_rect_min_lat=boundary_rect_min_lat,
672
+ boundary_rect_min_lon=boundary_rect_min_lon,
673
+ boundary_rect_max_lat=boundary_rect_max_lat,
674
+ boundary_rect_max_lon=boundary_rect_max_lon,
675
+ boundary_circle_lat=boundary_circle_lat,
676
+ boundary_circle_lon=boundary_circle_lon,
677
+ boundary_circle_radius=boundary_circle_radius,
678
+ size=size,
679
+ lang=lang,
680
+ _request_auth=_request_auth,
681
+ _content_type=_content_type,
682
+ _headers=_headers,
683
+ _host_index=_host_index
684
+ )
685
+
686
+ _response_types_map: Dict[str, Optional[str]] = {
687
+ '200': "GeocodeResponseEnvelopePropertiesV2",
688
+ '400': "GeocodeResponseEnvelopePropertiesV2",
689
+ '500': "GeocodeResponseEnvelopePropertiesV2",
690
+ }
691
+ response_data = self.api_client.call_api(
692
+ *_param,
693
+ _request_timeout=_request_timeout
694
+ )
695
+ response_data.read()
696
+ return self.api_client.response_deserialize(
697
+ response_data=response_data,
698
+ response_types_map=_response_types_map,
699
+ ).data
700
+
701
+
702
+ @validate_call
703
+ def autocomplete_v2_with_http_info(
704
+ self,
705
+ text: Annotated[StrictStr, Field(description="The text to search for (the start of an address, place name, etc.).")],
706
+ focus_point_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="The latitude of a focus point. If provided (along with longitude), the search results should be more locally relevant.")] = None,
707
+ focus_point_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 a focus point. If provided (along with longitude), the search results should be more locally relevant.")] = None,
708
+ layers: Annotated[Optional[List[LayerId]], Field(description="A list of layers to limit the search to.")] = None,
709
+ sources: Annotated[Optional[List[SourceId]], Field(description="A list of sources to limit the search to.")] = None,
710
+ boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of a region to limit the search to. Note: these are not stable for all datasets! For example, OSM features may be deleted and re-added with a new ID.")] = None,
711
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of comma-separated country codes in ISO 3116-1 alpha-2 or alpha-3 format. The search will be limited to these countries.")] = None,
712
+ boundary_rect_min_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="The minimum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
713
+ boundary_rect_min_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 minimum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
714
+ boundary_rect_max_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="The maximum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
715
+ boundary_rect_max_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 maximum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
716
+ boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.")] = None,
717
+ 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. NOTE: Requires boundary.circle.lon.")] = None,
718
+ boundary_circle_radius: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="The radius of the circle (in kilometers) to limit the search to. NOTE: Requires the other boundary.circle parameters to take effect. Defaults to 50km if unspecified.")] = None,
719
+ size: Annotated[Optional[Annotated[int, Field(le=25, strict=True, ge=1)]], Field(description="The maximum number of items to return from a query.")] = None,
720
+ lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.")] = None,
721
+ _request_timeout: Union[
722
+ None,
723
+ Annotated[StrictFloat, Field(gt=0)],
724
+ Tuple[
725
+ Annotated[StrictFloat, Field(gt=0)],
726
+ Annotated[StrictFloat, Field(gt=0)]
727
+ ]
728
+ ] = None,
729
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
730
+ _content_type: Optional[StrictStr] = None,
731
+ _headers: Optional[Dict[StrictStr, Any]] = None,
732
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
733
+ ) -> ApiResponse[GeocodeResponseEnvelopePropertiesV2]:
734
+ """autocomplete_v2
735
+
736
+
737
+ :param text: The text to search for (the start of an address, place name, etc.). (required)
738
+ :type text: str
739
+ :param focus_point_lat: The latitude of a focus point. If provided (along with longitude), the search results should be more locally relevant.
740
+ :type focus_point_lat: float
741
+ :param focus_point_lon: The longitude of a focus point. If provided (along with longitude), the search results should be more locally relevant.
742
+ :type focus_point_lon: float
743
+ :param layers: A list of layers to limit the search to.
744
+ :type layers: List[LayerId]
745
+ :param sources: A list of sources to limit the search to.
746
+ :type sources: List[SourceId]
747
+ :param boundary_gid: The GID of a region to limit the search to. Note: these are not stable for all datasets! For example, OSM features may be deleted and re-added with a new ID.
748
+ :type boundary_gid: str
749
+ :param boundary_country: A list of comma-separated country codes in ISO 3116-1 alpha-2 or alpha-3 format. The search will be limited to these countries.
750
+ :type boundary_country: List[str]
751
+ :param boundary_rect_min_lat: The minimum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
752
+ :type boundary_rect_min_lat: float
753
+ :param boundary_rect_min_lon: The minimum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
754
+ :type boundary_rect_min_lon: float
755
+ :param boundary_rect_max_lat: The maximum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
756
+ :type boundary_rect_max_lat: float
757
+ :param boundary_rect_max_lon: The maximum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
758
+ :type boundary_rect_max_lon: float
759
+ :param boundary_circle_lat: The latitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.
760
+ :type boundary_circle_lat: float
761
+ :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.
762
+ :type boundary_circle_lon: float
763
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. NOTE: Requires the other boundary.circle parameters to take effect. Defaults to 50km if unspecified.
764
+ :type boundary_circle_radius: int
765
+ :param size: The maximum number of items to return from a query.
766
+ :type size: int
767
+ :param lang: A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.
768
+ :type lang: str
769
+ :param _request_timeout: timeout setting for this request. If one
770
+ number provided, it will be total request
771
+ timeout. It can also be a pair (tuple) of
772
+ (connection, read) timeouts.
773
+ :type _request_timeout: int, tuple(int, int), optional
774
+ :param _request_auth: set to override the auth_settings for an a single
775
+ request; this effectively ignores the
776
+ authentication in the spec for a single request.
777
+ :type _request_auth: dict, optional
778
+ :param _content_type: force content-type for the request.
779
+ :type _content_type: str, Optional
780
+ :param _headers: set to override the headers for a single
781
+ request; this effectively ignores the headers
782
+ in the spec for a single request.
783
+ :type _headers: dict, optional
784
+ :param _host_index: set to override the host_index for a single
785
+ request; this effectively ignores the host_index
786
+ in the spec for a single request.
787
+ :type _host_index: int, optional
788
+ :return: Returns the result object.
789
+ """ # noqa: E501
790
+
791
+ _param = self._autocomplete_v2_serialize(
792
+ text=text,
793
+ focus_point_lat=focus_point_lat,
794
+ focus_point_lon=focus_point_lon,
795
+ layers=layers,
796
+ sources=sources,
797
+ boundary_gid=boundary_gid,
798
+ boundary_country=boundary_country,
799
+ boundary_rect_min_lat=boundary_rect_min_lat,
800
+ boundary_rect_min_lon=boundary_rect_min_lon,
801
+ boundary_rect_max_lat=boundary_rect_max_lat,
802
+ boundary_rect_max_lon=boundary_rect_max_lon,
803
+ boundary_circle_lat=boundary_circle_lat,
804
+ boundary_circle_lon=boundary_circle_lon,
805
+ boundary_circle_radius=boundary_circle_radius,
806
+ size=size,
807
+ lang=lang,
808
+ _request_auth=_request_auth,
809
+ _content_type=_content_type,
810
+ _headers=_headers,
811
+ _host_index=_host_index
812
+ )
813
+
814
+ _response_types_map: Dict[str, Optional[str]] = {
815
+ '200': "GeocodeResponseEnvelopePropertiesV2",
816
+ '400': "GeocodeResponseEnvelopePropertiesV2",
817
+ '500': "GeocodeResponseEnvelopePropertiesV2",
818
+ }
819
+ response_data = self.api_client.call_api(
820
+ *_param,
821
+ _request_timeout=_request_timeout
822
+ )
823
+ response_data.read()
824
+ return self.api_client.response_deserialize(
825
+ response_data=response_data,
826
+ response_types_map=_response_types_map,
827
+ )
828
+
829
+
830
+ @validate_call
831
+ def autocomplete_v2_without_preload_content(
832
+ self,
833
+ text: Annotated[StrictStr, Field(description="The text to search for (the start of an address, place name, etc.).")],
834
+ focus_point_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="The latitude of a focus point. If provided (along with longitude), the search results should be more locally relevant.")] = None,
835
+ focus_point_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 a focus point. If provided (along with longitude), the search results should be more locally relevant.")] = None,
836
+ layers: Annotated[Optional[List[LayerId]], Field(description="A list of layers to limit the search to.")] = None,
837
+ sources: Annotated[Optional[List[SourceId]], Field(description="A list of sources to limit the search to.")] = None,
838
+ boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of a region to limit the search to. Note: these are not stable for all datasets! For example, OSM features may be deleted and re-added with a new ID.")] = None,
839
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of comma-separated country codes in ISO 3116-1 alpha-2 or alpha-3 format. The search will be limited to these countries.")] = None,
840
+ boundary_rect_min_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="The minimum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
841
+ boundary_rect_min_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 minimum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
842
+ boundary_rect_max_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="The maximum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
843
+ boundary_rect_max_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 maximum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.")] = None,
844
+ boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.")] = None,
845
+ 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. NOTE: Requires boundary.circle.lon.")] = None,
846
+ boundary_circle_radius: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="The radius of the circle (in kilometers) to limit the search to. NOTE: Requires the other boundary.circle parameters to take effect. Defaults to 50km if unspecified.")] = None,
847
+ size: Annotated[Optional[Annotated[int, Field(le=25, strict=True, ge=1)]], Field(description="The maximum number of items to return from a query.")] = None,
848
+ lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.")] = None,
849
+ _request_timeout: Union[
850
+ None,
851
+ Annotated[StrictFloat, Field(gt=0)],
852
+ Tuple[
853
+ Annotated[StrictFloat, Field(gt=0)],
854
+ Annotated[StrictFloat, Field(gt=0)]
855
+ ]
856
+ ] = None,
857
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
858
+ _content_type: Optional[StrictStr] = None,
859
+ _headers: Optional[Dict[StrictStr, Any]] = None,
860
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
861
+ ) -> RESTResponseType:
862
+ """autocomplete_v2
863
+
864
+
865
+ :param text: The text to search for (the start of an address, place name, etc.). (required)
866
+ :type text: str
867
+ :param focus_point_lat: The latitude of a focus point. If provided (along with longitude), the search results should be more locally relevant.
868
+ :type focus_point_lat: float
869
+ :param focus_point_lon: The longitude of a focus point. If provided (along with longitude), the search results should be more locally relevant.
870
+ :type focus_point_lon: float
871
+ :param layers: A list of layers to limit the search to.
872
+ :type layers: List[LayerId]
873
+ :param sources: A list of sources to limit the search to.
874
+ :type sources: List[SourceId]
875
+ :param boundary_gid: The GID of a region to limit the search to. Note: these are not stable for all datasets! For example, OSM features may be deleted and re-added with a new ID.
876
+ :type boundary_gid: str
877
+ :param boundary_country: A list of comma-separated country codes in ISO 3116-1 alpha-2 or alpha-3 format. The search will be limited to these countries.
878
+ :type boundary_country: List[str]
879
+ :param boundary_rect_min_lat: The minimum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
880
+ :type boundary_rect_min_lat: float
881
+ :param boundary_rect_min_lon: The minimum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
882
+ :type boundary_rect_min_lon: float
883
+ :param boundary_rect_max_lat: The maximum latitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
884
+ :type boundary_rect_max_lat: float
885
+ :param boundary_rect_max_lon: The maximum longitude component of a search bounding box. NOTE: Requires all other boundary.rect parameters to be specified.
886
+ :type boundary_rect_max_lon: float
887
+ :param boundary_circle_lat: The latitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.
888
+ :type boundary_circle_lat: float
889
+ :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.
890
+ :type boundary_circle_lon: float
891
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. NOTE: Requires the other boundary.circle parameters to take effect. Defaults to 50km if unspecified.
892
+ :type boundary_circle_radius: int
893
+ :param size: The maximum number of items to return from a query.
894
+ :type size: int
895
+ :param lang: A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.
896
+ :type lang: str
897
+ :param _request_timeout: timeout setting for this request. If one
898
+ number provided, it will be total request
899
+ timeout. It can also be a pair (tuple) of
900
+ (connection, read) timeouts.
901
+ :type _request_timeout: int, tuple(int, int), optional
902
+ :param _request_auth: set to override the auth_settings for an a single
903
+ request; this effectively ignores the
904
+ authentication in the spec for a single request.
905
+ :type _request_auth: dict, optional
906
+ :param _content_type: force content-type for the request.
907
+ :type _content_type: str, Optional
908
+ :param _headers: set to override the headers for a single
909
+ request; this effectively ignores the headers
910
+ in the spec for a single request.
911
+ :type _headers: dict, optional
912
+ :param _host_index: set to override the host_index for a single
913
+ request; this effectively ignores the host_index
914
+ in the spec for a single request.
915
+ :type _host_index: int, optional
916
+ :return: Returns the result object.
917
+ """ # noqa: E501
918
+
919
+ _param = self._autocomplete_v2_serialize(
920
+ text=text,
921
+ focus_point_lat=focus_point_lat,
922
+ focus_point_lon=focus_point_lon,
923
+ layers=layers,
924
+ sources=sources,
925
+ boundary_gid=boundary_gid,
926
+ boundary_country=boundary_country,
927
+ boundary_rect_min_lat=boundary_rect_min_lat,
928
+ boundary_rect_min_lon=boundary_rect_min_lon,
929
+ boundary_rect_max_lat=boundary_rect_max_lat,
930
+ boundary_rect_max_lon=boundary_rect_max_lon,
931
+ boundary_circle_lat=boundary_circle_lat,
932
+ boundary_circle_lon=boundary_circle_lon,
933
+ boundary_circle_radius=boundary_circle_radius,
934
+ size=size,
935
+ lang=lang,
936
+ _request_auth=_request_auth,
937
+ _content_type=_content_type,
938
+ _headers=_headers,
939
+ _host_index=_host_index
940
+ )
941
+
942
+ _response_types_map: Dict[str, Optional[str]] = {
943
+ '200': "GeocodeResponseEnvelopePropertiesV2",
944
+ '400': "GeocodeResponseEnvelopePropertiesV2",
945
+ '500': "GeocodeResponseEnvelopePropertiesV2",
946
+ }
947
+ response_data = self.api_client.call_api(
948
+ *_param,
949
+ _request_timeout=_request_timeout
950
+ )
951
+ return response_data.response
952
+
953
+
954
+ def _autocomplete_v2_serialize(
955
+ self,
956
+ text,
957
+ focus_point_lat,
958
+ focus_point_lon,
959
+ layers,
960
+ sources,
961
+ boundary_gid,
962
+ boundary_country,
963
+ boundary_rect_min_lat,
964
+ boundary_rect_min_lon,
965
+ boundary_rect_max_lat,
966
+ boundary_rect_max_lon,
967
+ boundary_circle_lat,
968
+ boundary_circle_lon,
969
+ boundary_circle_radius,
970
+ size,
971
+ lang,
972
+ _request_auth,
973
+ _content_type,
974
+ _headers,
975
+ _host_index,
976
+ ) -> RequestSerialized:
977
+
978
+ _host = None
979
+
980
+ _collection_formats: Dict[str, str] = {
981
+ 'layers': 'csv',
982
+ 'sources': 'csv',
983
+ 'boundary.country': 'csv',
984
+ }
985
+
986
+ _path_params: Dict[str, str] = {}
987
+ _query_params: List[Tuple[str, str]] = []
988
+ _header_params: Dict[str, Optional[str]] = _headers or {}
989
+ _form_params: List[Tuple[str, str]] = []
990
+ _files: Dict[
991
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
992
+ ] = {}
993
+ _body_params: Optional[bytes] = None
994
+
995
+ # process the path parameters
996
+ # process the query parameters
997
+ if text is not None:
998
+
999
+ _query_params.append(('text', text))
1000
+
1001
+ if focus_point_lat is not None:
1002
+
1003
+ _query_params.append(('focus.point.lat', focus_point_lat))
1004
+
1005
+ if focus_point_lon is not None:
1006
+
1007
+ _query_params.append(('focus.point.lon', focus_point_lon))
1008
+
1009
+ if layers is not None:
1010
+
1011
+ _query_params.append(('layers', layers))
1012
+
1013
+ if sources is not None:
1014
+
1015
+ _query_params.append(('sources', sources))
1016
+
1017
+ if boundary_gid is not None:
1018
+
1019
+ _query_params.append(('boundary.gid', boundary_gid))
1020
+
1021
+ if boundary_country is not None:
1022
+
1023
+ _query_params.append(('boundary.country', boundary_country))
1024
+
1025
+ if boundary_rect_min_lat is not None:
1026
+
1027
+ _query_params.append(('boundary.rect.min_lat', boundary_rect_min_lat))
1028
+
1029
+ if boundary_rect_min_lon is not None:
1030
+
1031
+ _query_params.append(('boundary.rect.min_lon', boundary_rect_min_lon))
1032
+
1033
+ if boundary_rect_max_lat is not None:
1034
+
1035
+ _query_params.append(('boundary.rect.max_lat', boundary_rect_max_lat))
1036
+
1037
+ if boundary_rect_max_lon is not None:
1038
+
1039
+ _query_params.append(('boundary.rect.max_lon', boundary_rect_max_lon))
1040
+
1041
+ if boundary_circle_lat is not None:
1042
+
1043
+ _query_params.append(('boundary.circle.lat', boundary_circle_lat))
1044
+
1045
+ if boundary_circle_lon is not None:
1046
+
1047
+ _query_params.append(('boundary.circle.lon', boundary_circle_lon))
1048
+
1049
+ if boundary_circle_radius is not None:
1050
+
1051
+ _query_params.append(('boundary.circle.radius', boundary_circle_radius))
1052
+
1053
+ if size is not None:
1054
+
1055
+ _query_params.append(('size', size))
1056
+
1057
+ if lang is not None:
1058
+
1059
+ _query_params.append(('lang', lang))
1060
+
1061
+ # process the header parameters
1062
+ # process the form parameters
1063
+ # process the body parameter
1064
+
1065
+
1066
+ # set the HTTP header `Accept`
1067
+ if 'Accept' not in _header_params:
1068
+ _header_params['Accept'] = self.api_client.select_header_accept(
1069
+ [
1070
+ 'application/json'
1071
+ ]
1072
+ )
1073
+
1074
+
1075
+ # authentication setting
1076
+ _auth_settings: List[str] = [
1077
+ 'ApiKeyAuth'
1078
+ ]
1079
+
1080
+ return self.api_client.param_serialize(
1081
+ method='GET',
1082
+ resource_path='/geocoding/v2/autocomplete',
1083
+ path_params=_path_params,
1084
+ query_params=_query_params,
1085
+ header_params=_header_params,
1086
+ body=_body_params,
1087
+ post_params=_form_params,
1088
+ files=_files,
1089
+ auth_settings=_auth_settings,
1090
+ collection_formats=_collection_formats,
1091
+ _host=_host,
1092
+ _request_auth=_request_auth
1093
+ )
1094
+
1095
+
1096
+
1097
+
1098
+ @validate_call
1099
+ def place_details(
573
1100
  self,
574
1101
  ids: Annotated[List[StrictStr], Field(description="A list of GIDs to search for.")],
575
1102
  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,
@@ -616,7 +1143,7 @@ class GeocodingApi:
616
1143
  :return: Returns the result object.
617
1144
  """ # noqa: E501
618
1145
 
619
- _param = self._place_serialize(
1146
+ _param = self._place_details_serialize(
620
1147
  ids=ids,
621
1148
  lang=lang,
622
1149
  _request_auth=_request_auth,
@@ -641,7 +1168,7 @@ class GeocodingApi:
641
1168
 
642
1169
 
643
1170
  @validate_call
644
- def place_with_http_info(
1171
+ def place_details_with_http_info(
645
1172
  self,
646
1173
  ids: Annotated[List[StrictStr], Field(description="A list of GIDs to search for.")],
647
1174
  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,
@@ -688,7 +1215,7 @@ class GeocodingApi:
688
1215
  :return: Returns the result object.
689
1216
  """ # noqa: E501
690
1217
 
691
- _param = self._place_serialize(
1218
+ _param = self._place_details_serialize(
692
1219
  ids=ids,
693
1220
  lang=lang,
694
1221
  _request_auth=_request_auth,
@@ -713,7 +1240,7 @@ class GeocodingApi:
713
1240
 
714
1241
 
715
1242
  @validate_call
716
- def place_without_preload_content(
1243
+ def place_details_without_preload_content(
717
1244
  self,
718
1245
  ids: Annotated[List[StrictStr], Field(description="A list of GIDs to search for.")],
719
1246
  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,
@@ -760,7 +1287,7 @@ class GeocodingApi:
760
1287
  :return: Returns the result object.
761
1288
  """ # noqa: E501
762
1289
 
763
- _param = self._place_serialize(
1290
+ _param = self._place_details_serialize(
764
1291
  ids=ids,
765
1292
  lang=lang,
766
1293
  _request_auth=_request_auth,
@@ -780,7 +1307,7 @@ class GeocodingApi:
780
1307
  return response_data.response
781
1308
 
782
1309
 
783
- def _place_serialize(
1310
+ def _place_details_serialize(
784
1311
  self,
785
1312
  ids,
786
1313
  lang,
@@ -852,6 +1379,290 @@ class GeocodingApi:
852
1379
 
853
1380
 
854
1381
 
1382
+ @validate_call
1383
+ def place_details_v2(
1384
+ self,
1385
+ ids: List[StrictStr],
1386
+ lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.")] = None,
1387
+ _request_timeout: Union[
1388
+ None,
1389
+ Annotated[StrictFloat, Field(gt=0)],
1390
+ Tuple[
1391
+ Annotated[StrictFloat, Field(gt=0)],
1392
+ Annotated[StrictFloat, Field(gt=0)]
1393
+ ]
1394
+ ] = None,
1395
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1396
+ _content_type: Optional[StrictStr] = None,
1397
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1398
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1399
+ ) -> GeocodeResponseEnvelopePropertiesV2:
1400
+ """place_details_v2
1401
+
1402
+
1403
+ :param ids: (required)
1404
+ :type ids: List[str]
1405
+ :param lang: A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.
1406
+ :type lang: str
1407
+ :param _request_timeout: timeout setting for this request. If one
1408
+ number provided, it will be total request
1409
+ timeout. It can also be a pair (tuple) of
1410
+ (connection, read) timeouts.
1411
+ :type _request_timeout: int, tuple(int, int), optional
1412
+ :param _request_auth: set to override the auth_settings for an a single
1413
+ request; this effectively ignores the
1414
+ authentication in the spec for a single request.
1415
+ :type _request_auth: dict, optional
1416
+ :param _content_type: force content-type for the request.
1417
+ :type _content_type: str, Optional
1418
+ :param _headers: set to override the headers for a single
1419
+ request; this effectively ignores the headers
1420
+ in the spec for a single request.
1421
+ :type _headers: dict, optional
1422
+ :param _host_index: set to override the host_index for a single
1423
+ request; this effectively ignores the host_index
1424
+ in the spec for a single request.
1425
+ :type _host_index: int, optional
1426
+ :return: Returns the result object.
1427
+ """ # noqa: E501
1428
+
1429
+ _param = self._place_details_v2_serialize(
1430
+ ids=ids,
1431
+ lang=lang,
1432
+ _request_auth=_request_auth,
1433
+ _content_type=_content_type,
1434
+ _headers=_headers,
1435
+ _host_index=_host_index
1436
+ )
1437
+
1438
+ _response_types_map: Dict[str, Optional[str]] = {
1439
+ '200': "GeocodeResponseEnvelopePropertiesV2",
1440
+ '400': "GeocodeResponseEnvelopePropertiesV2",
1441
+ '500': "GeocodeResponseEnvelopePropertiesV2",
1442
+ }
1443
+ response_data = self.api_client.call_api(
1444
+ *_param,
1445
+ _request_timeout=_request_timeout
1446
+ )
1447
+ response_data.read()
1448
+ return self.api_client.response_deserialize(
1449
+ response_data=response_data,
1450
+ response_types_map=_response_types_map,
1451
+ ).data
1452
+
1453
+
1454
+ @validate_call
1455
+ def place_details_v2_with_http_info(
1456
+ self,
1457
+ ids: List[StrictStr],
1458
+ lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.")] = None,
1459
+ _request_timeout: Union[
1460
+ None,
1461
+ Annotated[StrictFloat, Field(gt=0)],
1462
+ Tuple[
1463
+ Annotated[StrictFloat, Field(gt=0)],
1464
+ Annotated[StrictFloat, Field(gt=0)]
1465
+ ]
1466
+ ] = None,
1467
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1468
+ _content_type: Optional[StrictStr] = None,
1469
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1470
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1471
+ ) -> ApiResponse[GeocodeResponseEnvelopePropertiesV2]:
1472
+ """place_details_v2
1473
+
1474
+
1475
+ :param ids: (required)
1476
+ :type ids: List[str]
1477
+ :param lang: A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.
1478
+ :type lang: str
1479
+ :param _request_timeout: timeout setting for this request. If one
1480
+ number provided, it will be total request
1481
+ timeout. It can also be a pair (tuple) of
1482
+ (connection, read) timeouts.
1483
+ :type _request_timeout: int, tuple(int, int), optional
1484
+ :param _request_auth: set to override the auth_settings for an a single
1485
+ request; this effectively ignores the
1486
+ authentication in the spec for a single request.
1487
+ :type _request_auth: dict, optional
1488
+ :param _content_type: force content-type for the request.
1489
+ :type _content_type: str, Optional
1490
+ :param _headers: set to override the headers for a single
1491
+ request; this effectively ignores the headers
1492
+ in the spec for a single request.
1493
+ :type _headers: dict, optional
1494
+ :param _host_index: set to override the host_index for a single
1495
+ request; this effectively ignores the host_index
1496
+ in the spec for a single request.
1497
+ :type _host_index: int, optional
1498
+ :return: Returns the result object.
1499
+ """ # noqa: E501
1500
+
1501
+ _param = self._place_details_v2_serialize(
1502
+ ids=ids,
1503
+ lang=lang,
1504
+ _request_auth=_request_auth,
1505
+ _content_type=_content_type,
1506
+ _headers=_headers,
1507
+ _host_index=_host_index
1508
+ )
1509
+
1510
+ _response_types_map: Dict[str, Optional[str]] = {
1511
+ '200': "GeocodeResponseEnvelopePropertiesV2",
1512
+ '400': "GeocodeResponseEnvelopePropertiesV2",
1513
+ '500': "GeocodeResponseEnvelopePropertiesV2",
1514
+ }
1515
+ response_data = self.api_client.call_api(
1516
+ *_param,
1517
+ _request_timeout=_request_timeout
1518
+ )
1519
+ response_data.read()
1520
+ return self.api_client.response_deserialize(
1521
+ response_data=response_data,
1522
+ response_types_map=_response_types_map,
1523
+ )
1524
+
1525
+
1526
+ @validate_call
1527
+ def place_details_v2_without_preload_content(
1528
+ self,
1529
+ ids: List[StrictStr],
1530
+ lang: Annotated[Optional[StrictStr], Field(description="A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.")] = None,
1531
+ _request_timeout: Union[
1532
+ None,
1533
+ Annotated[StrictFloat, Field(gt=0)],
1534
+ Tuple[
1535
+ Annotated[StrictFloat, Field(gt=0)],
1536
+ Annotated[StrictFloat, Field(gt=0)]
1537
+ ]
1538
+ ] = None,
1539
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1540
+ _content_type: Optional[StrictStr] = None,
1541
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1542
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1543
+ ) -> RESTResponseType:
1544
+ """place_details_v2
1545
+
1546
+
1547
+ :param ids: (required)
1548
+ :type ids: List[str]
1549
+ :param lang: A BCP47 language tag which specifies a preference for localization of results. There is no default value, so place names will be returned as-is, which is usually in the local language. NOTE: The Accept-Language header is also respected, and many user agents will set it automatically.
1550
+ :type lang: str
1551
+ :param _request_timeout: timeout setting for this request. If one
1552
+ number provided, it will be total request
1553
+ timeout. It can also be a pair (tuple) of
1554
+ (connection, read) timeouts.
1555
+ :type _request_timeout: int, tuple(int, int), optional
1556
+ :param _request_auth: set to override the auth_settings for an a single
1557
+ request; this effectively ignores the
1558
+ authentication in the spec for a single request.
1559
+ :type _request_auth: dict, optional
1560
+ :param _content_type: force content-type for the request.
1561
+ :type _content_type: str, Optional
1562
+ :param _headers: set to override the headers for a single
1563
+ request; this effectively ignores the headers
1564
+ in the spec for a single request.
1565
+ :type _headers: dict, optional
1566
+ :param _host_index: set to override the host_index for a single
1567
+ request; this effectively ignores the host_index
1568
+ in the spec for a single request.
1569
+ :type _host_index: int, optional
1570
+ :return: Returns the result object.
1571
+ """ # noqa: E501
1572
+
1573
+ _param = self._place_details_v2_serialize(
1574
+ ids=ids,
1575
+ lang=lang,
1576
+ _request_auth=_request_auth,
1577
+ _content_type=_content_type,
1578
+ _headers=_headers,
1579
+ _host_index=_host_index
1580
+ )
1581
+
1582
+ _response_types_map: Dict[str, Optional[str]] = {
1583
+ '200': "GeocodeResponseEnvelopePropertiesV2",
1584
+ '400': "GeocodeResponseEnvelopePropertiesV2",
1585
+ '500': "GeocodeResponseEnvelopePropertiesV2",
1586
+ }
1587
+ response_data = self.api_client.call_api(
1588
+ *_param,
1589
+ _request_timeout=_request_timeout
1590
+ )
1591
+ return response_data.response
1592
+
1593
+
1594
+ def _place_details_v2_serialize(
1595
+ self,
1596
+ ids,
1597
+ lang,
1598
+ _request_auth,
1599
+ _content_type,
1600
+ _headers,
1601
+ _host_index,
1602
+ ) -> RequestSerialized:
1603
+
1604
+ _host = None
1605
+
1606
+ _collection_formats: Dict[str, str] = {
1607
+ 'ids': 'csv',
1608
+ }
1609
+
1610
+ _path_params: Dict[str, str] = {}
1611
+ _query_params: List[Tuple[str, str]] = []
1612
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1613
+ _form_params: List[Tuple[str, str]] = []
1614
+ _files: Dict[
1615
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1616
+ ] = {}
1617
+ _body_params: Optional[bytes] = None
1618
+
1619
+ # process the path parameters
1620
+ # process the query parameters
1621
+ if ids is not None:
1622
+
1623
+ _query_params.append(('ids', ids))
1624
+
1625
+ if lang is not None:
1626
+
1627
+ _query_params.append(('lang', lang))
1628
+
1629
+ # process the header parameters
1630
+ # process the form parameters
1631
+ # process the body parameter
1632
+
1633
+
1634
+ # set the HTTP header `Accept`
1635
+ if 'Accept' not in _header_params:
1636
+ _header_params['Accept'] = self.api_client.select_header_accept(
1637
+ [
1638
+ 'application/json'
1639
+ ]
1640
+ )
1641
+
1642
+
1643
+ # authentication setting
1644
+ _auth_settings: List[str] = [
1645
+ 'ApiKeyAuth'
1646
+ ]
1647
+
1648
+ return self.api_client.param_serialize(
1649
+ method='GET',
1650
+ resource_path='/geocoding/v2/place_details',
1651
+ path_params=_path_params,
1652
+ query_params=_query_params,
1653
+ header_params=_header_params,
1654
+ body=_body_params,
1655
+ post_params=_form_params,
1656
+ files=_files,
1657
+ auth_settings=_auth_settings,
1658
+ collection_formats=_collection_formats,
1659
+ _host=_host,
1660
+ _request_auth=_request_auth
1661
+ )
1662
+
1663
+
1664
+
1665
+
855
1666
  @validate_call
856
1667
  def reverse(
857
1668
  self,
@@ -860,7 +1671,7 @@ class GeocodingApi:
860
1671
  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,
861
1672
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
862
1673
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
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,
1674
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
864
1675
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
865
1676
  size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
866
1677
  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,
@@ -891,7 +1702,7 @@ class GeocodingApi:
891
1702
  :type layers: List[GeocodingLayer]
892
1703
  :param sources: A list of sources to limit the search to.
893
1704
  :type sources: List[GeocodingSource]
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.
1705
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
895
1706
  :type boundary_country: List[str]
896
1707
  :param boundary_gid: The GID of an area to limit the search to.
897
1708
  :type boundary_gid: str
@@ -960,7 +1771,7 @@ class GeocodingApi:
960
1771
  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,
961
1772
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
962
1773
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
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,
1774
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
964
1775
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
965
1776
  size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
966
1777
  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,
@@ -991,7 +1802,7 @@ class GeocodingApi:
991
1802
  :type layers: List[GeocodingLayer]
992
1803
  :param sources: A list of sources to limit the search to.
993
1804
  :type sources: List[GeocodingSource]
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.
1805
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
995
1806
  :type boundary_country: List[str]
996
1807
  :param boundary_gid: The GID of an area to limit the search to.
997
1808
  :type boundary_gid: str
@@ -1060,7 +1871,7 @@ class GeocodingApi:
1060
1871
  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,
1061
1872
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
1062
1873
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
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,
1874
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
1064
1875
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
1065
1876
  size: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return.")] = None,
1066
1877
  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,
@@ -1091,7 +1902,7 @@ class GeocodingApi:
1091
1902
  :type layers: List[GeocodingLayer]
1092
1903
  :param sources: A list of sources to limit the search to.
1093
1904
  :type sources: List[GeocodingSource]
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.
1905
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
1095
1906
  :type boundary_country: List[str]
1096
1907
  :param boundary_gid: The GID of an area to limit the search to.
1097
1908
  :type boundary_gid: str
@@ -1270,7 +2081,7 @@ class GeocodingApi:
1270
2081
  boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. Requires `boundary.circle.lon`.")] = None,
1271
2082
  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,
1272
2083
  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,
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,
2084
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
1274
2085
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
1275
2086
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
1276
2087
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
@@ -1313,7 +2124,7 @@ class GeocodingApi:
1313
2124
  :type boundary_circle_lon: float
1314
2125
  :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
1315
2126
  :type boundary_circle_radius: float
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.
2127
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
1317
2128
  :type boundary_country: List[str]
1318
2129
  :param boundary_gid: The GID of an area to limit the search to.
1319
2130
  :type boundary_gid: str
@@ -1398,7 +2209,7 @@ class GeocodingApi:
1398
2209
  boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. Requires `boundary.circle.lon`.")] = None,
1399
2210
  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,
1400
2211
  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,
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,
2212
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
1402
2213
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
1403
2214
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
1404
2215
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
@@ -1441,7 +2252,7 @@ class GeocodingApi:
1441
2252
  :type boundary_circle_lon: float
1442
2253
  :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
1443
2254
  :type boundary_circle_radius: float
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.
2255
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
1445
2256
  :type boundary_country: List[str]
1446
2257
  :param boundary_gid: The GID of an area to limit the search to.
1447
2258
  :type boundary_gid: str
@@ -1526,7 +2337,7 @@ class GeocodingApi:
1526
2337
  boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. Requires `boundary.circle.lon`.")] = None,
1527
2338
  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,
1528
2339
  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,
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,
2340
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
1530
2341
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
1531
2342
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
1532
2343
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
@@ -1569,7 +2380,7 @@ class GeocodingApi:
1569
2380
  :type boundary_circle_lon: float
1570
2381
  :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
1571
2382
  :type boundary_circle_radius: float
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.
2383
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
1573
2384
  :type boundary_country: List[str]
1574
2385
  :param boundary_gid: The GID of an area to limit the search to.
1575
2386
  :type boundary_gid: str
@@ -2069,7 +2880,7 @@ class GeocodingApi:
2069
2880
  county: Annotated[Optional[StrictStr], Field(description="Administrative divisions between localities and regions. Not commonly used as input to structured geocoding.")] = None,
2070
2881
  region: Annotated[Optional[StrictStr], Field(description="Typically the first administrative division within a country. For example, a US state or a Canadian province.")] = None,
2071
2882
  postalcode: Annotated[Optional[StrictStr], Field(description="A mail sorting code.")] = None,
2072
- country: Annotated[Optional[StrictStr], Field(description="A full name (ex: Canada), or a 2 or 3 character ISO code. Prefer ISO codes when possible.")] = None,
2883
+ country: Annotated[Optional[StrictStr], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2073
2884
  focus_point_lat: Annotated[Optional[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 to focus the search on. This will bias results toward the focus point. Requires `focus.point.lon`.")] = None,
2074
2885
  focus_point_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 point to focus the search on. This will bias results toward the focus point. Requires `focus.point.lat`.")] = None,
2075
2886
  boundary_rect_min_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="Defines the min latitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
@@ -2079,7 +2890,7 @@ class GeocodingApi:
2079
2890
  boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. Requires `boundary.circle.lon`.")] = None,
2080
2891
  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,
2081
2892
  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,
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,
2893
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2083
2894
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
2084
2895
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
2085
2896
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
@@ -2116,7 +2927,7 @@ class GeocodingApi:
2116
2927
  :type region: str
2117
2928
  :param postalcode: A mail sorting code.
2118
2929
  :type postalcode: str
2119
- :param country: A full name (ex: Canada), or a 2 or 3 character ISO code. Prefer ISO codes when possible.
2930
+ :param country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2120
2931
  :type country: str
2121
2932
  :param focus_point_lat: The latitude of the point to focus the search on. This will bias results toward the focus point. Requires `focus.point.lon`.
2122
2933
  :type focus_point_lat: float
@@ -2136,7 +2947,7 @@ class GeocodingApi:
2136
2947
  :type boundary_circle_lon: float
2137
2948
  :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
2138
2949
  :type boundary_circle_radius: float
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.
2950
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2140
2951
  :type boundary_country: List[str]
2141
2952
  :param boundary_gid: The GID of an area to limit the search to.
2142
2953
  :type boundary_gid: str
@@ -2225,7 +3036,7 @@ class GeocodingApi:
2225
3036
  county: Annotated[Optional[StrictStr], Field(description="Administrative divisions between localities and regions. Not commonly used as input to structured geocoding.")] = None,
2226
3037
  region: Annotated[Optional[StrictStr], Field(description="Typically the first administrative division within a country. For example, a US state or a Canadian province.")] = None,
2227
3038
  postalcode: Annotated[Optional[StrictStr], Field(description="A mail sorting code.")] = None,
2228
- country: Annotated[Optional[StrictStr], Field(description="A full name (ex: Canada), or a 2 or 3 character ISO code. Prefer ISO codes when possible.")] = None,
3039
+ country: Annotated[Optional[StrictStr], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2229
3040
  focus_point_lat: Annotated[Optional[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 to focus the search on. This will bias results toward the focus point. Requires `focus.point.lon`.")] = None,
2230
3041
  focus_point_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 point to focus the search on. This will bias results toward the focus point. Requires `focus.point.lat`.")] = None,
2231
3042
  boundary_rect_min_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="Defines the min latitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
@@ -2235,7 +3046,7 @@ class GeocodingApi:
2235
3046
  boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. Requires `boundary.circle.lon`.")] = None,
2236
3047
  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,
2237
3048
  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,
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,
3049
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2239
3050
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
2240
3051
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
2241
3052
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
@@ -2272,7 +3083,7 @@ class GeocodingApi:
2272
3083
  :type region: str
2273
3084
  :param postalcode: A mail sorting code.
2274
3085
  :type postalcode: str
2275
- :param country: A full name (ex: Canada), or a 2 or 3 character ISO code. Prefer ISO codes when possible.
3086
+ :param country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2276
3087
  :type country: str
2277
3088
  :param focus_point_lat: The latitude of the point to focus the search on. This will bias results toward the focus point. Requires `focus.point.lon`.
2278
3089
  :type focus_point_lat: float
@@ -2292,7 +3103,7 @@ class GeocodingApi:
2292
3103
  :type boundary_circle_lon: float
2293
3104
  :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
2294
3105
  :type boundary_circle_radius: float
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.
3106
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2296
3107
  :type boundary_country: List[str]
2297
3108
  :param boundary_gid: The GID of an area to limit the search to.
2298
3109
  :type boundary_gid: str
@@ -2381,7 +3192,7 @@ class GeocodingApi:
2381
3192
  county: Annotated[Optional[StrictStr], Field(description="Administrative divisions between localities and regions. Not commonly used as input to structured geocoding.")] = None,
2382
3193
  region: Annotated[Optional[StrictStr], Field(description="Typically the first administrative division within a country. For example, a US state or a Canadian province.")] = None,
2383
3194
  postalcode: Annotated[Optional[StrictStr], Field(description="A mail sorting code.")] = None,
2384
- country: Annotated[Optional[StrictStr], Field(description="A full name (ex: Canada), or a 2 or 3 character ISO code. Prefer ISO codes when possible.")] = None,
3195
+ country: Annotated[Optional[StrictStr], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2385
3196
  focus_point_lat: Annotated[Optional[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 to focus the search on. This will bias results toward the focus point. Requires `focus.point.lon`.")] = None,
2386
3197
  focus_point_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 point to focus the search on. This will bias results toward the focus point. Requires `focus.point.lat`.")] = None,
2387
3198
  boundary_rect_min_lat: Annotated[Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]], Field(description="Defines the min latitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
@@ -2391,7 +3202,7 @@ class GeocodingApi:
2391
3202
  boundary_circle_lat: Annotated[Optional[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 center of a circle to limit the search to. Requires `boundary.circle.lon`.")] = None,
2392
3203
  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,
2393
3204
  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,
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,
3205
+ boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2395
3206
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
2396
3207
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
2397
3208
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
@@ -2428,7 +3239,7 @@ class GeocodingApi:
2428
3239
  :type region: str
2429
3240
  :param postalcode: A mail sorting code.
2430
3241
  :type postalcode: str
2431
- :param country: A full name (ex: Canada), or a 2 or 3 character ISO code. Prefer ISO codes when possible.
3242
+ :param country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2432
3243
  :type country: str
2433
3244
  :param focus_point_lat: The latitude of the point to focus the search on. This will bias results toward the focus point. Requires `focus.point.lon`.
2434
3245
  :type focus_point_lat: float
@@ -2448,7 +3259,7 @@ class GeocodingApi:
2448
3259
  :type boundary_circle_lon: float
2449
3260
  :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
2450
3261
  :type boundary_circle_radius: float
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.
3262
+ :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2452
3263
  :type boundary_country: List[str]
2453
3264
  :param boundary_gid: The GID of an area to limit the search to.
2454
3265
  :type boundary_gid: str