diff --git a/README.md b/README.md index c4c9afc..5a16be9 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Use this web-based service to streamline your app’s API by moving georelated s Use the SPM string to easily include the dependendency in your `Package.swift` file ```swift -.package(url: "https://github.com/fpseverino/apple-maps-kit.git", from: "0.1.0") +.package(url: "https://github.com/fpseverino/apple-maps-kit.git", from: "0.2.0") ``` and add it to your target's dependencies: @@ -36,10 +36,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let places = try await client.geocode(address: "1 Apple Park, Cupertino, CA") @@ -58,10 +58,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let places = try await client.reverseGeocode(latitude: 37.33182, longitude: -122.03118) @@ -80,10 +80,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let searchResponse = try await client.search(for: "eiffel tower") @@ -102,10 +102,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let results = try await client.searchAutoComplete(for: "eiffel") @@ -124,10 +124,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let directions = try await client.directions( @@ -149,10 +149,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let coordinateEtas = try await client.eta( @@ -168,3 +168,29 @@ let addressEtas = try await client.etaBetweenAddresses( to: ["Golden Gate Park, San Francisco"], ) ``` + +### Search for places using identifiers + +Obtain a set of ``Place`` objects for a given set of Place IDs or get a list of alternate Place IDs given one or more Place IDs. + +```swift +import AppleMapsKit +import AsyncHTTPClient + +let client = try await AppleMapsClient( + httpClient: HTTPClient(...), + teamID: "DEF123GHIJ", + keyID: "ABC123DEFG", + key: """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ +) + +let place = try await client.place(id: "I7C250D2CDCB364A") + +let placesResponse = try await client.places(ids: ["ICFA2FAE5487B94AF", "IA6FD1E86A544F69D"]) + +let alternateIDsResponse = try await client.alternatePlaceIDs(ids: ["I7C250D2CDCB364A", "ICFA2FAE5487B94AF"]) +``` diff --git a/Sources/AppleMapsKit/AppleMapsKit.docc/AppleMapsKit.md b/Sources/AppleMapsKit/AppleMapsKit.docc/AppleMapsKit.md index 994c93d..afa0d90 100644 --- a/Sources/AppleMapsKit/AppleMapsKit.docc/AppleMapsKit.md +++ b/Sources/AppleMapsKit/AppleMapsKit.docc/AppleMapsKit.md @@ -11,7 +11,7 @@ Use this web-based service to streamline your app’s API by moving georelated s Use the SPM string to easily include the dependendency in your `Package.swift` file ```swift -.package(url: "https://github.com/fpseverino/apple-maps-kit.git", from: "0.1.0") +.package(url: "https://github.com/fpseverino/apple-maps-kit.git", from: "0.2.0") ``` and add it to your target's dependencies: @@ -28,12 +28,12 @@ and add it to your target's dependencies: - ``MapRegion`` - ``Location`` - ``StructuredAddress`` +- ``Place`` ### Geocoding - - -- ``Place`` ### Searching @@ -59,6 +59,12 @@ and add it to your target's dependencies: - ``Eta`` - ``EtaTransportType`` +### Places + +- +- ``PlacesResponse`` +- ``AlternateIDsResponse`` + ### Errors - ``ErrorResponse`` diff --git a/Sources/AppleMapsKit/AppleMapsKit.docc/Geocode.md b/Sources/AppleMapsKit/AppleMapsKit.docc/Geocode.md index 2cfa80b..7e62ddc 100644 --- a/Sources/AppleMapsKit/AppleMapsKit.docc/Geocode.md +++ b/Sources/AppleMapsKit/AppleMapsKit.docc/Geocode.md @@ -13,10 +13,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let places = try await client.geocode(address: "1 Apple Park, Cupertino, CA") diff --git a/Sources/AppleMapsKit/AppleMapsKit.docc/GettingDirections.md b/Sources/AppleMapsKit/AppleMapsKit.docc/GettingDirections.md index 3e05a2d..534dba5 100644 --- a/Sources/AppleMapsKit/AppleMapsKit.docc/GettingDirections.md +++ b/Sources/AppleMapsKit/AppleMapsKit.docc/GettingDirections.md @@ -13,10 +13,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let directions = try await client.directions( diff --git a/Sources/AppleMapsKit/AppleMapsKit.docc/GettingETAs.md b/Sources/AppleMapsKit/AppleMapsKit.docc/GettingETAs.md index 45f6918..819a138 100644 --- a/Sources/AppleMapsKit/AppleMapsKit.docc/GettingETAs.md +++ b/Sources/AppleMapsKit/AppleMapsKit.docc/GettingETAs.md @@ -13,10 +13,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let coordinateEtas = try await client.eta( diff --git a/Sources/AppleMapsKit/AppleMapsKit.docc/GettingPlaces.md b/Sources/AppleMapsKit/AppleMapsKit.docc/GettingPlaces.md new file mode 100644 index 0000000..d9b2392 --- /dev/null +++ b/Sources/AppleMapsKit/AppleMapsKit.docc/GettingPlaces.md @@ -0,0 +1,27 @@ +# Search for places using identifiers + +Obtain a set of ``Place`` objects for a given set of Place IDs or get a list of alternate Place IDs given one or more Place IDs. + +## Overview + +```swift +import AppleMapsKit +import AsyncHTTPClient + +let client = try await AppleMapsClient( + httpClient: HTTPClient(...), + teamID: "DEF123GHIJ", + keyID: "ABC123DEFG", + key: """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ +) + +let place = try await client.place(id: "I7C250D2CDCB364A") + +let placesResponse = try await client.places(ids: ["ICFA2FAE5487B94AF", "IA6FD1E86A544F69D"]) + +let alternateIDsResponse = try await client.alternatePlaceIDs(ids: ["I7C250D2CDCB364A", "ICFA2FAE5487B94AF"]) +``` diff --git a/Sources/AppleMapsKit/AppleMapsKit.docc/ReverseGeocode.md b/Sources/AppleMapsKit/AppleMapsKit.docc/ReverseGeocode.md index bc14827..3dac3f7 100644 --- a/Sources/AppleMapsKit/AppleMapsKit.docc/ReverseGeocode.md +++ b/Sources/AppleMapsKit/AppleMapsKit.docc/ReverseGeocode.md @@ -13,10 +13,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let places = try await client.reverseGeocode(latitude: 37.33182, longitude: -122.03118) diff --git a/Sources/AppleMapsKit/AppleMapsKit.docc/Search.md b/Sources/AppleMapsKit/AppleMapsKit.docc/Search.md index 94a6d51..118e7b9 100644 --- a/Sources/AppleMapsKit/AppleMapsKit.docc/Search.md +++ b/Sources/AppleMapsKit/AppleMapsKit.docc/Search.md @@ -13,10 +13,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let searchResponse = try await client.search(for: "eiffel tower") diff --git a/Sources/AppleMapsKit/AppleMapsKit.docc/SearchAutoComplete.md b/Sources/AppleMapsKit/AppleMapsKit.docc/SearchAutoComplete.md index a1508c5..89d2948 100644 --- a/Sources/AppleMapsKit/AppleMapsKit.docc/SearchAutoComplete.md +++ b/Sources/AppleMapsKit/AppleMapsKit.docc/SearchAutoComplete.md @@ -13,10 +13,10 @@ let client = try await AppleMapsClient( teamID: "DEF123GHIJ", keyID: "ABC123DEFG", key: """ - -----BEGIN PRIVATE KEY----- - ... - -----END PRIVATE KEY----- - """ + -----BEGIN PRIVATE KEY----- + ... + -----END PRIVATE KEY----- + """ ) let results = try await client.searchAutoComplete(for: "eiffel")