stadiamaps 6.0.0__py3-none-any.whl → 6.2.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 (153) hide show
  1. stadiamaps/__init__.py +2 -2
  2. stadiamaps/api/geocoding_api.py +436 -31
  3. stadiamaps/api/geospatial_api.py +1 -1
  4. stadiamaps/api/routing_api.py +1 -1
  5. stadiamaps/api_client.py +2 -2
  6. stadiamaps/configuration.py +3 -3
  7. stadiamaps/exceptions.py +1 -1
  8. stadiamaps/models/__init__.py +1 -1
  9. stadiamaps/models/access.py +1 -1
  10. stadiamaps/models/addendum_v2.py +1 -1
  11. stadiamaps/models/address_components_v2.py +1 -1
  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 +1 -1
  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 +1 -1
  35. stadiamaps/models/feature_properties_v2_properties.py +1 -1
  36. stadiamaps/models/foursquare_addendum.py +1 -1
  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 +1 -1
  42. stadiamaps/models/geocoding_geo_json_feature.py +1 -1
  43. stadiamaps/models/geocoding_geo_json_properties.py +1 -1
  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 +10 -3
  48. stadiamaps/models/geocoding_object.py +1 -1
  49. stadiamaps/models/geocoding_source.py +1 -1
  50. stadiamaps/models/geonames_addendum.py +1 -1
  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 +1 -1
  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 +1 -1
  74. stadiamaps/models/match_type.py +1 -1
  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 +10 -3
  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 +1 -1
  107. stadiamaps/models/pedestrian_type.py +1 -1
  108. stadiamaps/models/point.py +1 -1
  109. stadiamaps/models/precision.py +1 -1
  110. stadiamaps/models/properties_v2.py +1 -1
  111. stadiamaps/models/restrictions.py +1 -1
  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 +1 -1
  124. stadiamaps/models/routing_waypoint.py +1 -1
  125. stadiamaps/models/routing_waypoint_all_of_search_filter.py +1 -1
  126. stadiamaps/models/search_query.py +1 -1
  127. stadiamaps/models/search_structured_query.py +1 -1
  128. stadiamaps/models/simple_routing_waypoint.py +1 -1
  129. stadiamaps/models/source_attribution.py +1 -1
  130. stadiamaps/models/source_id.py +1 -1
  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 -1
  137. stadiamaps/models/trace_edge.py +1 -1
  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 +3 -3
  144. stadiamaps/models/wof_context.py +22 -2
  145. stadiamaps/models/wof_context_component.py +1 -1
  146. stadiamaps/rest.py +1 -1
  147. {stadiamaps-6.0.0.dist-info → stadiamaps-6.2.0.dist-info}/METADATA +2 -2
  148. stadiamaps-6.2.0.dist-info/RECORD +183 -0
  149. {stadiamaps-6.0.0.dist-info → stadiamaps-6.2.0.dist-info}/WHEEL +1 -1
  150. test/integration/test_gecoding.py +28 -3
  151. stadiamaps-6.0.0.dist-info/RECORD +0 -183
  152. {stadiamaps-6.0.0.dist-info → stadiamaps-6.2.0.dist-info}/licenses/LICENSE.txt +0 -0
  153. {stadiamaps-6.0.0.dist-info → stadiamaps-6.2.0.dist-info}/top_level.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: 9.0.0
8
+ The version of the OpenAPI document: 9.2.1
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -59,7 +59,7 @@ class GeocodingApi:
59
59
  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="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
60
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,
61
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,
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,
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 (search) or 1km (reverse) if unspecified.")] = None,
63
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,
64
64
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
65
65
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
@@ -101,7 +101,7 @@ class GeocodingApi:
101
101
  :type boundary_circle_lat: float
102
102
  :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.
103
103
  :type boundary_circle_lon: float
104
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
104
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
105
105
  :type boundary_circle_radius: float
106
106
  :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
107
107
  :type boundary_country: List[str]
@@ -187,7 +187,7 @@ class GeocodingApi:
187
187
  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="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
188
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,
189
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,
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,
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 (search) or 1km (reverse) if unspecified.")] = None,
191
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,
192
192
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
193
193
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
@@ -229,7 +229,7 @@ class GeocodingApi:
229
229
  :type boundary_circle_lat: float
230
230
  :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.
231
231
  :type boundary_circle_lon: float
232
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
232
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
233
233
  :type boundary_circle_radius: float
234
234
  :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
235
235
  :type boundary_country: List[str]
@@ -315,7 +315,7 @@ class GeocodingApi:
315
315
  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="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
316
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,
317
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,
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,
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 (search) or 1km (reverse) if unspecified.")] = None,
319
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,
320
320
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
321
321
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
@@ -357,7 +357,7 @@ class GeocodingApi:
357
357
  :type boundary_circle_lat: float
358
358
  :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.
359
359
  :type boundary_circle_lon: float
360
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
360
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
361
361
  :type boundary_circle_radius: float
362
362
  :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
363
363
  :type boundary_country: List[str]
@@ -586,7 +586,7 @@ class GeocodingApi:
586
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
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
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,
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.lat.")] = None,
590
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
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
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,
@@ -630,7 +630,7 @@ class GeocodingApi:
630
630
  :type boundary_rect_max_lon: float
631
631
  :param boundary_circle_lat: The latitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.
632
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.
633
+ :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lat.
634
634
  :type boundary_circle_lon: float
635
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
636
  :type boundary_circle_radius: int
@@ -714,7 +714,7 @@ class GeocodingApi:
714
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
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
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,
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.lat.")] = None,
718
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
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
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,
@@ -758,7 +758,7 @@ class GeocodingApi:
758
758
  :type boundary_rect_max_lon: float
759
759
  :param boundary_circle_lat: The latitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.
760
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.
761
+ :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lat.
762
762
  :type boundary_circle_lon: float
763
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
764
  :type boundary_circle_radius: int
@@ -842,7 +842,7 @@ class GeocodingApi:
842
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
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
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,
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.lat.")] = None,
846
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
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
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,
@@ -886,7 +886,7 @@ class GeocodingApi:
886
886
  :type boundary_rect_max_lon: float
887
887
  :param boundary_circle_lat: The latitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lon.
888
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.
889
+ :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. NOTE: Requires boundary.circle.lat.
890
890
  :type boundary_circle_lon: float
891
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
892
  :type boundary_circle_radius: int
@@ -1668,7 +1668,7 @@ class GeocodingApi:
1668
1668
  self,
1669
1669
  point_lat: Annotated[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]], Field(description="The latitude of the point at which to perform the search.")],
1670
1670
  point_lon: Annotated[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]], Field(description="The longitude of the point at which to perform the search.")],
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,
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 (search) or 1km (reverse) if unspecified.")] = None,
1672
1672
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
1673
1673
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
1674
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,
@@ -1696,7 +1696,7 @@ class GeocodingApi:
1696
1696
  :type point_lat: float
1697
1697
  :param point_lon: The longitude of the point at which to perform the search. (required)
1698
1698
  :type point_lon: float
1699
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
1699
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
1700
1700
  :type boundary_circle_radius: float
1701
1701
  :param layers: A list of layers to limit the search to.
1702
1702
  :type layers: List[GeocodingLayer]
@@ -1768,7 +1768,7 @@ class GeocodingApi:
1768
1768
  self,
1769
1769
  point_lat: Annotated[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]], Field(description="The latitude of the point at which to perform the search.")],
1770
1770
  point_lon: Annotated[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]], Field(description="The longitude of the point at which to perform the search.")],
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,
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 (search) or 1km (reverse) if unspecified.")] = None,
1772
1772
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
1773
1773
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
1774
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,
@@ -1796,7 +1796,7 @@ class GeocodingApi:
1796
1796
  :type point_lat: float
1797
1797
  :param point_lon: The longitude of the point at which to perform the search. (required)
1798
1798
  :type point_lon: float
1799
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
1799
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
1800
1800
  :type boundary_circle_radius: float
1801
1801
  :param layers: A list of layers to limit the search to.
1802
1802
  :type layers: List[GeocodingLayer]
@@ -1868,7 +1868,7 @@ class GeocodingApi:
1868
1868
  self,
1869
1869
  point_lat: Annotated[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]], Field(description="The latitude of the point at which to perform the search.")],
1870
1870
  point_lon: Annotated[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]], Field(description="The longitude of the point at which to perform the search.")],
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,
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 (search) or 1km (reverse) if unspecified.")] = None,
1872
1872
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
1873
1873
  sources: Annotated[Optional[List[GeocodingSource]], Field(description="A list of sources to limit the search to.")] = None,
1874
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,
@@ -1896,7 +1896,7 @@ class GeocodingApi:
1896
1896
  :type point_lat: float
1897
1897
  :param point_lon: The longitude of the point at which to perform the search. (required)
1898
1898
  :type point_lon: float
1899
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
1899
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
1900
1900
  :type boundary_circle_radius: float
1901
1901
  :param layers: A list of layers to limit the search to.
1902
1902
  :type layers: List[GeocodingLayer]
@@ -2068,6 +2068,411 @@ class GeocodingApi:
2068
2068
 
2069
2069
 
2070
2070
 
2071
+ @validate_call
2072
+ def reverse_v2(
2073
+ self,
2074
+ point_lat: Annotated[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]], Field(description="The latitude of the point at which to perform the search.")],
2075
+ point_lon: Annotated[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]], Field(description="The longitude of the point at which to perform the search.")],
2076
+ layers: Annotated[Optional[List[LayerId]], Field(description="A list of layers to limit the search to.")] = None,
2077
+ sources: Annotated[Optional[List[SourceId]], Field(description="A list of sources to limit the search to.")] = None,
2078
+ 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,
2079
+ 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,
2080
+ boundary_circle_radius: Annotated[Optional[Annotated[int, Field(le=25, strict=True, ge=0)]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 1km if unspecified.")] = None,
2081
+ 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,
2082
+ 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,
2083
+ _request_timeout: Union[
2084
+ None,
2085
+ Annotated[StrictFloat, Field(gt=0)],
2086
+ Tuple[
2087
+ Annotated[StrictFloat, Field(gt=0)],
2088
+ Annotated[StrictFloat, Field(gt=0)]
2089
+ ]
2090
+ ] = None,
2091
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2092
+ _content_type: Optional[StrictStr] = None,
2093
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2094
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2095
+ ) -> GeocodeResponseEnvelopePropertiesV2:
2096
+ """reverse_v2
2097
+
2098
+
2099
+ :param point_lat: The latitude of the point at which to perform the search. (required)
2100
+ :type point_lat: float
2101
+ :param point_lon: The longitude of the point at which to perform the search. (required)
2102
+ :type point_lon: float
2103
+ :param layers: A list of layers to limit the search to.
2104
+ :type layers: List[LayerId]
2105
+ :param sources: A list of sources to limit the search to.
2106
+ :type sources: List[SourceId]
2107
+ :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.
2108
+ :type boundary_gid: str
2109
+ :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.
2110
+ :type boundary_country: List[str]
2111
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 1km if unspecified.
2112
+ :type boundary_circle_radius: int
2113
+ :param size: The maximum number of items to return from a query.
2114
+ :type size: int
2115
+ :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.
2116
+ :type lang: str
2117
+ :param _request_timeout: timeout setting for this request. If one
2118
+ number provided, it will be total request
2119
+ timeout. It can also be a pair (tuple) of
2120
+ (connection, read) timeouts.
2121
+ :type _request_timeout: int, tuple(int, int), optional
2122
+ :param _request_auth: set to override the auth_settings for an a single
2123
+ request; this effectively ignores the
2124
+ authentication in the spec for a single request.
2125
+ :type _request_auth: dict, optional
2126
+ :param _content_type: force content-type for the request.
2127
+ :type _content_type: str, Optional
2128
+ :param _headers: set to override the headers for a single
2129
+ request; this effectively ignores the headers
2130
+ in the spec for a single request.
2131
+ :type _headers: dict, optional
2132
+ :param _host_index: set to override the host_index for a single
2133
+ request; this effectively ignores the host_index
2134
+ in the spec for a single request.
2135
+ :type _host_index: int, optional
2136
+ :return: Returns the result object.
2137
+ """ # noqa: E501
2138
+
2139
+ _param = self._reverse_v2_serialize(
2140
+ point_lat=point_lat,
2141
+ point_lon=point_lon,
2142
+ layers=layers,
2143
+ sources=sources,
2144
+ boundary_gid=boundary_gid,
2145
+ boundary_country=boundary_country,
2146
+ boundary_circle_radius=boundary_circle_radius,
2147
+ size=size,
2148
+ lang=lang,
2149
+ _request_auth=_request_auth,
2150
+ _content_type=_content_type,
2151
+ _headers=_headers,
2152
+ _host_index=_host_index
2153
+ )
2154
+
2155
+ _response_types_map: Dict[str, Optional[str]] = {
2156
+ '200': "GeocodeResponseEnvelopePropertiesV2",
2157
+ '400': "GeocodeResponseEnvelopePropertiesV2",
2158
+ '500': "GeocodeResponseEnvelopePropertiesV2",
2159
+ }
2160
+ response_data = self.api_client.call_api(
2161
+ *_param,
2162
+ _request_timeout=_request_timeout
2163
+ )
2164
+ response_data.read()
2165
+ return self.api_client.response_deserialize(
2166
+ response_data=response_data,
2167
+ response_types_map=_response_types_map,
2168
+ ).data
2169
+
2170
+
2171
+ @validate_call
2172
+ def reverse_v2_with_http_info(
2173
+ self,
2174
+ point_lat: Annotated[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]], Field(description="The latitude of the point at which to perform the search.")],
2175
+ point_lon: Annotated[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]], Field(description="The longitude of the point at which to perform the search.")],
2176
+ layers: Annotated[Optional[List[LayerId]], Field(description="A list of layers to limit the search to.")] = None,
2177
+ sources: Annotated[Optional[List[SourceId]], Field(description="A list of sources to limit the search to.")] = None,
2178
+ 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,
2179
+ 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,
2180
+ boundary_circle_radius: Annotated[Optional[Annotated[int, Field(le=25, strict=True, ge=0)]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 1km if unspecified.")] = None,
2181
+ 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,
2182
+ 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,
2183
+ _request_timeout: Union[
2184
+ None,
2185
+ Annotated[StrictFloat, Field(gt=0)],
2186
+ Tuple[
2187
+ Annotated[StrictFloat, Field(gt=0)],
2188
+ Annotated[StrictFloat, Field(gt=0)]
2189
+ ]
2190
+ ] = None,
2191
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2192
+ _content_type: Optional[StrictStr] = None,
2193
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2194
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2195
+ ) -> ApiResponse[GeocodeResponseEnvelopePropertiesV2]:
2196
+ """reverse_v2
2197
+
2198
+
2199
+ :param point_lat: The latitude of the point at which to perform the search. (required)
2200
+ :type point_lat: float
2201
+ :param point_lon: The longitude of the point at which to perform the search. (required)
2202
+ :type point_lon: float
2203
+ :param layers: A list of layers to limit the search to.
2204
+ :type layers: List[LayerId]
2205
+ :param sources: A list of sources to limit the search to.
2206
+ :type sources: List[SourceId]
2207
+ :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.
2208
+ :type boundary_gid: str
2209
+ :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.
2210
+ :type boundary_country: List[str]
2211
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 1km if unspecified.
2212
+ :type boundary_circle_radius: int
2213
+ :param size: The maximum number of items to return from a query.
2214
+ :type size: int
2215
+ :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.
2216
+ :type lang: str
2217
+ :param _request_timeout: timeout setting for this request. If one
2218
+ number provided, it will be total request
2219
+ timeout. It can also be a pair (tuple) of
2220
+ (connection, read) timeouts.
2221
+ :type _request_timeout: int, tuple(int, int), optional
2222
+ :param _request_auth: set to override the auth_settings for an a single
2223
+ request; this effectively ignores the
2224
+ authentication in the spec for a single request.
2225
+ :type _request_auth: dict, optional
2226
+ :param _content_type: force content-type for the request.
2227
+ :type _content_type: str, Optional
2228
+ :param _headers: set to override the headers for a single
2229
+ request; this effectively ignores the headers
2230
+ in the spec for a single request.
2231
+ :type _headers: dict, optional
2232
+ :param _host_index: set to override the host_index for a single
2233
+ request; this effectively ignores the host_index
2234
+ in the spec for a single request.
2235
+ :type _host_index: int, optional
2236
+ :return: Returns the result object.
2237
+ """ # noqa: E501
2238
+
2239
+ _param = self._reverse_v2_serialize(
2240
+ point_lat=point_lat,
2241
+ point_lon=point_lon,
2242
+ layers=layers,
2243
+ sources=sources,
2244
+ boundary_gid=boundary_gid,
2245
+ boundary_country=boundary_country,
2246
+ boundary_circle_radius=boundary_circle_radius,
2247
+ size=size,
2248
+ lang=lang,
2249
+ _request_auth=_request_auth,
2250
+ _content_type=_content_type,
2251
+ _headers=_headers,
2252
+ _host_index=_host_index
2253
+ )
2254
+
2255
+ _response_types_map: Dict[str, Optional[str]] = {
2256
+ '200': "GeocodeResponseEnvelopePropertiesV2",
2257
+ '400': "GeocodeResponseEnvelopePropertiesV2",
2258
+ '500': "GeocodeResponseEnvelopePropertiesV2",
2259
+ }
2260
+ response_data = self.api_client.call_api(
2261
+ *_param,
2262
+ _request_timeout=_request_timeout
2263
+ )
2264
+ response_data.read()
2265
+ return self.api_client.response_deserialize(
2266
+ response_data=response_data,
2267
+ response_types_map=_response_types_map,
2268
+ )
2269
+
2270
+
2271
+ @validate_call
2272
+ def reverse_v2_without_preload_content(
2273
+ self,
2274
+ point_lat: Annotated[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]], Field(description="The latitude of the point at which to perform the search.")],
2275
+ point_lon: Annotated[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]], Field(description="The longitude of the point at which to perform the search.")],
2276
+ layers: Annotated[Optional[List[LayerId]], Field(description="A list of layers to limit the search to.")] = None,
2277
+ sources: Annotated[Optional[List[SourceId]], Field(description="A list of sources to limit the search to.")] = None,
2278
+ 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,
2279
+ 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,
2280
+ boundary_circle_radius: Annotated[Optional[Annotated[int, Field(le=25, strict=True, ge=0)]], Field(description="The radius of the circle (in kilometers) to limit the search to. Defaults to 1km if unspecified.")] = None,
2281
+ 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,
2282
+ 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,
2283
+ _request_timeout: Union[
2284
+ None,
2285
+ Annotated[StrictFloat, Field(gt=0)],
2286
+ Tuple[
2287
+ Annotated[StrictFloat, Field(gt=0)],
2288
+ Annotated[StrictFloat, Field(gt=0)]
2289
+ ]
2290
+ ] = None,
2291
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2292
+ _content_type: Optional[StrictStr] = None,
2293
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2294
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2295
+ ) -> RESTResponseType:
2296
+ """reverse_v2
2297
+
2298
+
2299
+ :param point_lat: The latitude of the point at which to perform the search. (required)
2300
+ :type point_lat: float
2301
+ :param point_lon: The longitude of the point at which to perform the search. (required)
2302
+ :type point_lon: float
2303
+ :param layers: A list of layers to limit the search to.
2304
+ :type layers: List[LayerId]
2305
+ :param sources: A list of sources to limit the search to.
2306
+ :type sources: List[SourceId]
2307
+ :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.
2308
+ :type boundary_gid: str
2309
+ :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.
2310
+ :type boundary_country: List[str]
2311
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 1km if unspecified.
2312
+ :type boundary_circle_radius: int
2313
+ :param size: The maximum number of items to return from a query.
2314
+ :type size: int
2315
+ :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.
2316
+ :type lang: str
2317
+ :param _request_timeout: timeout setting for this request. If one
2318
+ number provided, it will be total request
2319
+ timeout. It can also be a pair (tuple) of
2320
+ (connection, read) timeouts.
2321
+ :type _request_timeout: int, tuple(int, int), optional
2322
+ :param _request_auth: set to override the auth_settings for an a single
2323
+ request; this effectively ignores the
2324
+ authentication in the spec for a single request.
2325
+ :type _request_auth: dict, optional
2326
+ :param _content_type: force content-type for the request.
2327
+ :type _content_type: str, Optional
2328
+ :param _headers: set to override the headers for a single
2329
+ request; this effectively ignores the headers
2330
+ in the spec for a single request.
2331
+ :type _headers: dict, optional
2332
+ :param _host_index: set to override the host_index for a single
2333
+ request; this effectively ignores the host_index
2334
+ in the spec for a single request.
2335
+ :type _host_index: int, optional
2336
+ :return: Returns the result object.
2337
+ """ # noqa: E501
2338
+
2339
+ _param = self._reverse_v2_serialize(
2340
+ point_lat=point_lat,
2341
+ point_lon=point_lon,
2342
+ layers=layers,
2343
+ sources=sources,
2344
+ boundary_gid=boundary_gid,
2345
+ boundary_country=boundary_country,
2346
+ boundary_circle_radius=boundary_circle_radius,
2347
+ size=size,
2348
+ lang=lang,
2349
+ _request_auth=_request_auth,
2350
+ _content_type=_content_type,
2351
+ _headers=_headers,
2352
+ _host_index=_host_index
2353
+ )
2354
+
2355
+ _response_types_map: Dict[str, Optional[str]] = {
2356
+ '200': "GeocodeResponseEnvelopePropertiesV2",
2357
+ '400': "GeocodeResponseEnvelopePropertiesV2",
2358
+ '500': "GeocodeResponseEnvelopePropertiesV2",
2359
+ }
2360
+ response_data = self.api_client.call_api(
2361
+ *_param,
2362
+ _request_timeout=_request_timeout
2363
+ )
2364
+ return response_data.response
2365
+
2366
+
2367
+ def _reverse_v2_serialize(
2368
+ self,
2369
+ point_lat,
2370
+ point_lon,
2371
+ layers,
2372
+ sources,
2373
+ boundary_gid,
2374
+ boundary_country,
2375
+ boundary_circle_radius,
2376
+ size,
2377
+ lang,
2378
+ _request_auth,
2379
+ _content_type,
2380
+ _headers,
2381
+ _host_index,
2382
+ ) -> RequestSerialized:
2383
+
2384
+ _host = None
2385
+
2386
+ _collection_formats: Dict[str, str] = {
2387
+ 'layers': 'csv',
2388
+ 'sources': 'csv',
2389
+ 'boundary.country': 'csv',
2390
+ }
2391
+
2392
+ _path_params: Dict[str, str] = {}
2393
+ _query_params: List[Tuple[str, str]] = []
2394
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2395
+ _form_params: List[Tuple[str, str]] = []
2396
+ _files: Dict[
2397
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2398
+ ] = {}
2399
+ _body_params: Optional[bytes] = None
2400
+
2401
+ # process the path parameters
2402
+ # process the query parameters
2403
+ if point_lat is not None:
2404
+
2405
+ _query_params.append(('point.lat', point_lat))
2406
+
2407
+ if point_lon is not None:
2408
+
2409
+ _query_params.append(('point.lon', point_lon))
2410
+
2411
+ if layers is not None:
2412
+
2413
+ _query_params.append(('layers', layers))
2414
+
2415
+ if sources is not None:
2416
+
2417
+ _query_params.append(('sources', sources))
2418
+
2419
+ if boundary_gid is not None:
2420
+
2421
+ _query_params.append(('boundary.gid', boundary_gid))
2422
+
2423
+ if boundary_country is not None:
2424
+
2425
+ _query_params.append(('boundary.country', boundary_country))
2426
+
2427
+ if boundary_circle_radius is not None:
2428
+
2429
+ _query_params.append(('boundary.circle.radius', boundary_circle_radius))
2430
+
2431
+ if size is not None:
2432
+
2433
+ _query_params.append(('size', size))
2434
+
2435
+ if lang is not None:
2436
+
2437
+ _query_params.append(('lang', lang))
2438
+
2439
+ # process the header parameters
2440
+ # process the form parameters
2441
+ # process the body parameter
2442
+
2443
+
2444
+ # set the HTTP header `Accept`
2445
+ if 'Accept' not in _header_params:
2446
+ _header_params['Accept'] = self.api_client.select_header_accept(
2447
+ [
2448
+ 'application/json'
2449
+ ]
2450
+ )
2451
+
2452
+
2453
+ # authentication setting
2454
+ _auth_settings: List[str] = [
2455
+ 'ApiKeyAuth'
2456
+ ]
2457
+
2458
+ return self.api_client.param_serialize(
2459
+ method='GET',
2460
+ resource_path='/geocoding/v2/reverse',
2461
+ path_params=_path_params,
2462
+ query_params=_query_params,
2463
+ header_params=_header_params,
2464
+ body=_body_params,
2465
+ post_params=_form_params,
2466
+ files=_files,
2467
+ auth_settings=_auth_settings,
2468
+ collection_formats=_collection_formats,
2469
+ _host=_host,
2470
+ _request_auth=_request_auth
2471
+ )
2472
+
2473
+
2474
+
2475
+
2071
2476
  @validate_call
2072
2477
  def search(
2073
2478
  self,
@@ -2080,7 +2485,7 @@ class GeocodingApi:
2080
2485
  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="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
2081
2486
  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,
2082
2487
  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,
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,
2488
+ 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 (search) or 1km (reverse) if unspecified.")] = None,
2084
2489
  boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2085
2490
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
2086
2491
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
@@ -2122,7 +2527,7 @@ class GeocodingApi:
2122
2527
  :type boundary_circle_lat: float
2123
2528
  :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.
2124
2529
  :type boundary_circle_lon: float
2125
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
2530
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
2126
2531
  :type boundary_circle_radius: float
2127
2532
  :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2128
2533
  :type boundary_country: List[str]
@@ -2208,7 +2613,7 @@ class GeocodingApi:
2208
2613
  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="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
2209
2614
  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,
2210
2615
  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,
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,
2616
+ 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 (search) or 1km (reverse) if unspecified.")] = None,
2212
2617
  boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2213
2618
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
2214
2619
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
@@ -2250,7 +2655,7 @@ class GeocodingApi:
2250
2655
  :type boundary_circle_lat: float
2251
2656
  :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.
2252
2657
  :type boundary_circle_lon: float
2253
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
2658
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
2254
2659
  :type boundary_circle_radius: float
2255
2660
  :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2256
2661
  :type boundary_country: List[str]
@@ -2336,7 +2741,7 @@ class GeocodingApi:
2336
2741
  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="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
2337
2742
  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,
2338
2743
  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,
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,
2744
+ 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 (search) or 1km (reverse) if unspecified.")] = None,
2340
2745
  boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2341
2746
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
2342
2747
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
@@ -2378,7 +2783,7 @@ class GeocodingApi:
2378
2783
  :type boundary_circle_lat: float
2379
2784
  :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.
2380
2785
  :type boundary_circle_lon: float
2381
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
2786
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
2382
2787
  :type boundary_circle_radius: float
2383
2788
  :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2384
2789
  :type boundary_country: List[str]
@@ -2889,7 +3294,7 @@ class GeocodingApi:
2889
3294
  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="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
2890
3295
  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,
2891
3296
  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,
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,
3297
+ 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 (search) or 1km (reverse) if unspecified.")] = None,
2893
3298
  boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
2894
3299
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
2895
3300
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
@@ -2945,7 +3350,7 @@ class GeocodingApi:
2945
3350
  :type boundary_circle_lat: float
2946
3351
  :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.
2947
3352
  :type boundary_circle_lon: float
2948
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
3353
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
2949
3354
  :type boundary_circle_radius: float
2950
3355
  :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
2951
3356
  :type boundary_country: List[str]
@@ -3045,7 +3450,7 @@ class GeocodingApi:
3045
3450
  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="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
3046
3451
  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,
3047
3452
  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,
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,
3453
+ 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 (search) or 1km (reverse) if unspecified.")] = None,
3049
3454
  boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
3050
3455
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
3051
3456
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
@@ -3101,7 +3506,7 @@ class GeocodingApi:
3101
3506
  :type boundary_circle_lat: float
3102
3507
  :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.
3103
3508
  :type boundary_circle_lon: float
3104
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
3509
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
3105
3510
  :type boundary_circle_radius: float
3106
3511
  :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
3107
3512
  :type boundary_country: List[str]
@@ -3201,7 +3606,7 @@ class GeocodingApi:
3201
3606
  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="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.")] = None,
3202
3607
  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,
3203
3608
  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,
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,
3609
+ 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 (search) or 1km (reverse) if unspecified.")] = None,
3205
3610
  boundary_country: Annotated[Optional[List[StrictStr]], Field(description="A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.")] = None,
3206
3611
  boundary_gid: Annotated[Optional[StrictStr], Field(description="The GID of an area to limit the search to.")] = None,
3207
3612
  layers: Annotated[Optional[List[GeocodingLayer]], Field(description="A list of layers to limit the search to.")] = None,
@@ -3257,7 +3662,7 @@ class GeocodingApi:
3257
3662
  :type boundary_circle_lat: float
3258
3663
  :param boundary_circle_lon: The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.
3259
3664
  :type boundary_circle_lon: float
3260
- :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
3665
+ :param boundary_circle_radius: The radius of the circle (in kilometers) to limit the search to. Defaults to 50km (search) or 1km (reverse) if unspecified.
3261
3666
  :type boundary_circle_radius: float
3262
3667
  :param boundary_country: A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
3263
3668
  :type boundary_country: List[str]