@aws-sdk/client-geo-places 3.830.0 → 3.835.0

package/dist-types/commands/SearchNearbyCommand.d.ts

@@ -27,7 +27,7 @@ declare const SearchNearbyCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Search nearby a specified location.</p>
+ * <p> <code>SearchNearby</code> queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -105,7 +105,7 @@ declare const SearchNearbyCommand_base: {
  * //         PostalCode: "STRING_VALUE",
  * //         Block: "STRING_VALUE",
  * //         SubBlock: "STRING_VALUE",
- * //         Intersection: [ // IntersectionList
+ * //         Intersection: [ // IntersectionStreetList
  * //           "STRING_VALUE",
  * //         ],
  * //         Street: "STRING_VALUE",
@@ -123,6 +123,11 @@ declare const SearchNearbyCommand_base: {
  * //         ],
  * //         AddressNumber: "STRING_VALUE",
  * //         Building: "STRING_VALUE",
+ * //         SecondaryAddressComponents: [ // SecondaryAddressComponentList
+ * //           { // SecondaryAddressComponent
+ * //             Number: "STRING_VALUE", // required
+ * //           },
+ * //         ],
  * //       },
  * //       AddressNumberCorrected: true || false,
  * //       Position: [ // Position

package/dist-types/commands/SearchTextCommand.d.ts

@@ -27,9 +27,7 @@ declare const SearchTextCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Use the <code>SearchText</code> operation to search for geocode and place information.
- *          You can then complete a follow-up query suggested from the <code>Suggest</code> API via a
- *          query id.</p>
+ * <p> <code>SearchText</code> searches for geocode and place information. You can then complete a follow-up query suggested from the <code>Suggest</code> API via a query id.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -96,7 +94,7 @@ declare const SearchTextCommand_base: {
  * //         PostalCode: "STRING_VALUE",
  * //         Block: "STRING_VALUE",
  * //         SubBlock: "STRING_VALUE",
- * //         Intersection: [ // IntersectionList
+ * //         Intersection: [ // IntersectionStreetList
  * //           "STRING_VALUE",
  * //         ],
  * //         Street: "STRING_VALUE",
@@ -114,6 +112,11 @@ declare const SearchTextCommand_base: {
  * //         ],
  * //         AddressNumber: "STRING_VALUE",
  * //         Building: "STRING_VALUE",
+ * //         SecondaryAddressComponents: [ // SecondaryAddressComponentList
+ * //           { // SecondaryAddressComponent
+ * //             Number: "STRING_VALUE", // required
+ * //           },
+ * //         ],
  * //       },
  * //       AddressNumberCorrected: true || false,
  * //       Position: [ // Position

package/dist-types/commands/SuggestCommand.d.ts

@@ -27,9 +27,7 @@ declare const SuggestCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>The <code>Suggest</code> operation finds addresses or place candidates based on
- *          incomplete or misspelled queries. You then select the best query to submit based on the
- *          returned results.</p>
+ * <p> <code>Suggest</code> provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -97,7 +95,7 @@ declare const SuggestCommand_base: {
  * //           PostalCode: "STRING_VALUE",
  * //           Block: "STRING_VALUE",
  * //           SubBlock: "STRING_VALUE",
- * //           Intersection: [ // IntersectionList
+ * //           Intersection: [ // IntersectionStreetList
  * //             "STRING_VALUE",
  * //           ],
  * //           Street: "STRING_VALUE",
@@ -115,6 +113,11 @@ declare const SuggestCommand_base: {
  * //           ],
  * //           AddressNumber: "STRING_VALUE",
  * //           Building: "STRING_VALUE",
+ * //           SecondaryAddressComponents: [ // SecondaryAddressComponentList
+ * //             { // SecondaryAddressComponent
+ * //               Number: "STRING_VALUE", // required
+ * //             },
+ * //           ],
  * //         },
  * //         Position: [ // Position
  * //           Number("double"),

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -8,7 +8,7 @@ export interface ClientInputEndpointParameters {
     endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
     region?: string | undefined | Provider<string | undefined>;
 }
-export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
     defaultSigningName: string;
 };
 export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;

package/dist-types/index.d.ts

@@ -1,41 +1,5 @@
 /**
- * <p>
- *       The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include:
- *   </p>
- *          <ul>
- *             <li>
- *                <p>Forward and reverse geocoding for addresses and coordinates</p>
- *             </li>
- *             <li>
- *                <p>Comprehensive place searches with detailed information, including:</p>
- *                <ul>
- *                   <li>
- *                      <p>Business names and addresses</p>
- *                   </li>
- *                   <li>
- *                      <p>Contact information</p>
- *                   </li>
- *                   <li>
- *                      <p>Hours of operation</p>
- *                   </li>
- *                   <li>
- *                      <p>POI (Points of Interest) categories</p>
- *                   </li>
- *                   <li>
- *                      <p>Food types for restaurants</p>
- *                   </li>
- *                   <li>
- *                      <p>Chain affiliation for relevant businesses</p>
- *                   </li>
- *                </ul>
- *             </li>
- *             <li>
- *                <p>Global data coverage with a wide range of POI categories</p>
- *             </li>
- *             <li>
- *                <p>Regular data updates to ensure accuracy and relevance</p>
- *             </li>
- *          </ul>
+ * <p> The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include: </p> <ul> <li> <p>Forward and reverse geocoding for addresses and coordinates</p> </li> <li> <p>Comprehensive place searches with detailed information, including:</p> <ul> <li> <p>Business names and addresses</p> </li> <li> <p>Contact information</p> </li> <li> <p>Hours of operation</p> </li> <li> <p>POI (Points of Interest) categories</p> </li> <li> <p>Food types for restaurants</p> </li> <li> <p>Chain affiliation for relevant businesses</p> </li> </ul> </li> <li> <p>Global data coverage with a wide range of POI categories</p> </li> <li> <p>Regular data updates to ensure accuracy and relevance</p> </li> </ul>
  *
  * @packageDocumentation
  */