@esri/arcgis-rest-places 1.0.2 → 1.2.0

package/dist/esm/openapi-types.d.ts

@@ -74,7 +74,7 @@ export interface paths {
          * To perform the request, you must supply the `x` and `y` coordinates of
          * the point from which to search. Optionally, you can also specify the:
          *
-         * - Search radius (up to 10,000 meters)
+         * - Search radius (1 to 10,000 meters)
          * - Category IDs
          * - Search text
          *
@@ -93,17 +93,20 @@ export interface paths {
         /**
          * The `/places/within-extent` request searches for places within an extent (bounding box).
          *
-         * You must supply the `xmin`,
-         * `ymin`, `xmax` and `ymax` coordinates to define the extent. The maximum width
-         * and height of an extent that can be used in a search is 20,000 meters.
+         * You must supply the `xmin`, `ymin`, `xmax` and `ymax` coordinates to
+         * define the extent. The maximum width and height of an extent that can be
+         * used in a search is 20,000 meters. The width and height of an extent
+         * must be greater than 0 meters.
          *
-         * You can also provide multiple categories or search text to find specific types of places within the extent.
+         * You can also provide multiple categories or search text to find specific
+         * types of places within the extent.
          *
-         * The default number of places returned (`pageSize`) is 10. The maximum `pageSize` value is 20.
+         * The default number of places returned (`pageSize`) is 10. The maximum
+         * `pageSize` value is 20.
          *
-         * If the `pagination.nextUrl` property in the response is populated, then you can
-         * page through the results to return more places. The maximum number of
-         * places that can be paged to is 200.
+         * If the `pagination.nextUrl` property in the response is populated, then
+         * you can page through the results to return more places. The maximum
+         * number of places that can be paged to is 200.
          *
          * **Note**: You cannot permanently store places. Please see the [Terms of
          * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
@@ -175,6 +178,9 @@ export interface paths {
          * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
          *
          * **Note**: Query parameters are case-sensitive.
+         *
+         * **Note**: Can be used in conjunction with the [Basemap Styles service](https://developers.arcgis.com/rest/basemap-styles) to request additional attributes
+         * for places retrieved using the [Places for basemaps](https://developers.arcgis.com/documentation/mapping-apis-and-services/maps/places-for-basemaps) workflow.
          */
         get: operations["placeIdGet"];
     };
@@ -186,7 +192,7 @@ export interface components {
          *
          * A place ID is a 32 character string.
          *
-         * @example 722d8e1ba4db8ec5ef256b09cf060782
+         * @example 2da082218b6f7538e52250999c8f8ef1
          */
         PlaceId: string;
         /**
@@ -202,7 +208,7 @@ export interface components {
              * This place Id can be passed to the `places/{placeId}` endpoint to
              * retrieve additional details.
              *
-             * @example 722d8e1ba4db8ec5ef256b09cf060782
+             * @example 2da082218b6f7538e52250999c8f8ef1
              */
             placeId: components["schemas"]["PlaceId"];
             /**
@@ -225,8 +231,8 @@ export interface components {
              *
              * @example [
              *   {
-             *     "categoryId": 17119,
-             *     "label": "Bicycle Store"
+             *     "categoryId": "11167",
+             *     "label": "Technology Business"
              *   }
              * ]
              */
@@ -245,6 +251,12 @@ export interface components {
              * @example 50
              */
             distance: number;
+            /**
+             * @description Details of an icon, suitable for depicting this place.
+             *
+             * To fetch icon details use the `icon` query parameter.
+             */
+            icon?: components["schemas"]["IconDetails"];
         };
         /**
          * @description A result of searching for places using a `places/within-extent` request.
@@ -258,7 +270,7 @@ export interface components {
              * This place Id can be passed to the `places/{placeId}` endpoint to
              * retrieve additional details.
              *
-             * @example 722d8e1ba4db8ec5ef256b09cf060782
+             * @example 2da082218b6f7538e52250999c8f8ef1
              */
             placeId: components["schemas"]["PlaceId"];
             /**
@@ -281,8 +293,8 @@ export interface components {
              *
              * @example [
              *   {
-             *     "categoryId": 17119,
-             *     "label": "Bicycle Store"
+             *     "categoryId": "11167",
+             *     "label": "Technology Business"
              *   }
              * ]
              */
@@ -295,6 +307,12 @@ export interface components {
              * @example Esri International
              */
             name: string;
+            /**
+             * @description Details of an icon, suitable for depicting this place.
+             *
+             * To fetch icon details use the `icon` query parameter.
+             */
+            icon?: components["schemas"]["IconDetails"];
         };
         /**
          * @description The additional details for a `Place`, including address, contact details, opening hours, and rating.
@@ -307,7 +325,7 @@ export interface components {
             /**
              * @description The unique Id of this place.
              *
-             * @example 722d8e1ba4db8ec5ef256b09cf060782
+             * @example 2da082218b6f7538e52250999c8f8ef1
              */
             placeId: components["schemas"]["PlaceId"];
             /**
@@ -323,8 +341,8 @@ export interface components {
              *
              * @example [
              *   {
-             *     "categoryId": 17119,
-             *     "label": "Bicycle Store"
+             *     "categoryId": "11167",
+             *     "label": "Technology Business"
              *   }
              * ]
              */
@@ -367,7 +385,7 @@ export interface components {
              */
             address?: components["schemas"]["Address"];
             /**
-             * @description A set of additional locations that represent the place, for example the location of the front door, or of a drop off point.
+             * @description A set of additional locations that represent the place as WGS84 points, for example the location of the front door, or of a drop off point.
              *
              * This object and child properties are part of the "Location"
              * attribute group.
@@ -414,6 +432,12 @@ export interface components {
              * ]
              */
             chains?: components["schemas"]["ChainInfo"][];
+            /**
+             * @description Details of an icon, suitable for depicting this place.
+             *
+             * To fetch icon details use the `icon` query parameter.
+             */
+            icon?: components["schemas"]["IconDetails"];
         };
         /** @example 17119 */
         CategoryId: string;
@@ -428,7 +452,7 @@ export interface components {
              * @description The category Id uniquely identifies this category or type of place.
              *
              * The name of the category can be looked up using the
-             * `places/categories` endpoint. For example, 17119 is the id for a
+             * `places/categories` endpoint. For example, "17119" is the id for a
              * "Bicycle Store".
              *
              * @example 17119
@@ -463,6 +487,12 @@ export interface components {
             fullLabel: string[];
             /** @description The list of parent category Ids for this category. */
             parents?: string[];
+            /**
+             * @description Details of an icon, suitable for depicting this place.
+             *
+             * To fetch icon details use the `icon` query parameter.
+             */
+            icon?: components["schemas"]["IconDetails"];
         };
         /**
          * Format: double
@@ -772,7 +802,7 @@ export interface components {
             user?: number | null;
         };
         /**
-         * @description A set of additional locations for the place.
+         * @description A set of additional locations for the place, as WGS84 points.
          *
          * This list provides alternative locations for accessing a place such as
          * `frontDoor` or `road`.
@@ -886,7 +916,7 @@ export interface components {
             /**
              * @description The census block Id of the place (US only).
              *
-             * @example 60710081003002
+             * @example 060710081003002
              */
             censusBlockId?: string | null;
         };
@@ -894,7 +924,7 @@ export interface components {
         SocialMedia: {
             /**
              * @description The facebook Id of the place.
-             * @example 211211155280
+             * @example 183768242996
              */
             facebookId?: string | null;
             /**
@@ -902,7 +932,10 @@ export interface components {
              * @example esri
              */
             twitter?: string | null;
-            /** @description The instagram ID of the place. */
+            /**
+             * @description The instagram ID of the place.
+             * @example esrigram
+             */
             instagram?: string | null;
         };
         /** @description The contact information for a place. */
@@ -915,7 +948,7 @@ export interface components {
             /**
              * Format: url
              * @description The website address of the place.
-             * @example https://www.esri.com/en-us/home
+             * @example https://www.esri.com
              */
             website?: string | null;
             /**
@@ -997,6 +1030,16 @@ export interface components {
                 restInfoUrl?: string;
             };
         };
+        /** @description Information about an icon for depicting a place or category. */
+        IconDetails: {
+            /**
+             * Format: url
+             * @description Url for an icon for this place or category in either `svg`, `cim` or `png` format.
+             *
+             * @example https://static.arcgis.com/icons/places/Default_Shop_or_Service_15.svg
+             */
+            url?: string;
+        };
     };
     responses: {
         /** Authentication Error. The API key or token is missing, invalid or expired. */
@@ -1080,25 +1123,25 @@ export interface components {
          */
         RadiusParam: components["schemas"]["SearchDistance"];
         /**
-         * @description The minimum x coordinate, or longitude, of the search extent.
+         * @description The minimum x coordinate, or longitude, of the search extent, in WGS84 decimal degrees.
          *
          * This is the furthest _west_ that will be searched.
          */
         XMinParam: components["schemas"]["XCoord"];
         /**
-         * @description The minimum y coordinate, or latitude, of the search extent.
+         * @description The minimum y coordinate, or latitude, of the search extent, in WGS84 decimal degrees.
          *
          * This is the furthest _south_ that will be searched.
          */
         YMinParam: components["schemas"]["YCoord"];
         /**
-         * @description The maximum x coordinate, or longitude, of the search extent.
+         * @description The maximum x coordinate, or longitude, of the search extent, in WGS84 decimal degrees.
          *
          * This is the furthest _east_ that will be searched.
          */
         XMaxParam: components["schemas"]["XCoord"];
         /**
-         * @description The maximum y coordinate, or latitude, of the search extent.
+         * @description The maximum y coordinate, or latitude, of the search extent, in WGS84 decimal degrees.
          *
          * This is the furthest _north_ that will be searched.
          */
@@ -1181,7 +1224,7 @@ export interface components {
          */
         RequestedFieldsParam: ("all" | "additionalLocations" | "additionalLocations:dropOff" | "additionalLocations:frontDoor" | "additionalLocations:road" | "additionalLocations:roof" | "address" | "address:adminRegion" | "address:censusBlockId" | "address:country" | "address:designatedMarketArea" | "address:extended" | "address:locality" | "address:neighborhood" | "address:poBox" | "address:postcode" | "address:postTown" | "address:region" | "address:streetAddress" | "categories" | "contactInfo" | "contactInfo:email" | "contactInfo:fax" | "contactInfo:telephone" | "contactInfo:website" | "chains" | "description" | "hours" | "hours:opening" | "hours:openingText" | "hours:popular" | "location" | "name" | "rating" | "rating:price" | "rating:user" | "socialMedia" | "socialMedia:facebookId" | "socialMedia:instagram" | "socialMedia:twitter")[];
         /**
-         * @description The authentication token with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
+         * @description The authentication token, created from an ArcGIS Location Platform account, with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
          *
          * The `token` parameter can be either an API Key or short-lived token. See
          * [ArcGIS security
@@ -1195,6 +1238,57 @@ export interface components {
          * - `X-Esri-Authorization: Bearer <YOUR_TOKEN>`
          */
         TokenParam: string;
+        /**
+         * @description Determines whether icons are returned and the type of icon to use with a place or category.
+         *
+         * ![example icon](https://static.arcgis.com/icons/places/Zoo_48.png)
+         *
+         * Use this parameter to define the type of icon URL for a given place or
+         * category. Place icons are available in the following formats:
+         *
+         * - `svg`
+         * - `cim` ([Cartographic Information Model](https://developers.arcgis.com/documentation/glossary/cim-symbol/))
+         * - `png` 48 x 48 pixels
+         *
+         * The SVG and CIM symbols default to 15 x 15 pixels but can be scaled
+         * smoothly for display in larger UI elements or to emphasize these
+         * features on a map. The PNG icons are provided as 48 x 48 pixels but for
+         * map display the recommended size is 16 x 16 pixels.
+         *
+         * The default is `none` (no icon URL will be returned).
+         */
+        IconParam: "none" | "svg" | "png" | "cim";
+        /**
+         * @description Optional case-sensitive parameter to specify the preferred language to
+         * use for category names.
+         *
+         * This query parameter uses language codes to specify the preferred
+         * language. If not set, or if no translation is available, the default
+         * behavior is to return category names in English.
+         *
+         * The language codes use the [CLDR](https://cldr.unicode.org/) (Common
+         * Locale Data Repository) format string that uses a two letter language
+         * code (e.g. "fr" for French) optionally followed by a two letter country
+         * code (e.g. "fr-CA" for French in Canada).
+         *
+         * If an unsupported language code is used, then the service will attempt
+         * to fall-back to the closest available language. This is done by
+         * stripping regional and extension subtags to find a known language code.
+         * For example, French Canadian (`fr-CA`) is unsupported so this falls back
+         * to French `fr`.
+         *
+         * Should the fallback fail, then the service will return category names in
+         * the default language `en` for English.
+         *
+         * Language codes:
+         * - English, default US - `en`
+         * - French - `fr`
+         * - German - `de`
+         * - Japanese - `ja`
+         * - Portuguese, default Brazil - `pt`
+         * - Spanish - `es`
+         */
+        LanguageParam: "en" | "es" | "de" | "fr" | "ja" | "pt";
     };
 }
 export interface operations {
@@ -1261,10 +1355,61 @@ export interface operations {
                  * "Coffee".
                  */
                 filter?: components["parameters"]["CategoriesFilterParam"];
+                /**
+                 * Determines whether icons are returned and the type of icon to use with a place or category.
+                 *
+                 * ![example icon](https://static.arcgis.com/icons/places/Zoo_48.png)
+                 *
+                 * Use this parameter to define the type of icon URL for a given place or
+                 * category. Place icons are available in the following formats:
+                 *
+                 * - `svg`
+                 * - `cim` ([Cartographic Information Model](https://developers.arcgis.com/documentation/glossary/cim-symbol/))
+                 * - `png` 48 x 48 pixels
+                 *
+                 * The SVG and CIM symbols default to 15 x 15 pixels but can be scaled
+                 * smoothly for display in larger UI elements or to emphasize these
+                 * features on a map. The PNG icons are provided as 48 x 48 pixels but for
+                 * map display the recommended size is 16 x 16 pixels.
+                 *
+                 * The default is `none` (no icon URL will be returned).
+                 */
+                icon?: components["parameters"]["IconParam"];
+                /**
+                 * Optional case-sensitive parameter to specify the preferred language to
+                 * use for category names.
+                 *
+                 * This query parameter uses language codes to specify the preferred
+                 * language. If not set, or if no translation is available, the default
+                 * behavior is to return category names in English.
+                 *
+                 * The language codes use the [CLDR](https://cldr.unicode.org/) (Common
+                 * Locale Data Repository) format string that uses a two letter language
+                 * code (e.g. "fr" for French) optionally followed by a two letter country
+                 * code (e.g. "fr-CA" for French in Canada).
+                 *
+                 * If an unsupported language code is used, then the service will attempt
+                 * to fall-back to the closest available language. This is done by
+                 * stripping regional and extension subtags to find a known language code.
+                 * For example, French Canadian (`fr-CA`) is unsupported so this falls back
+                 * to French `fr`.
+                 *
+                 * Should the fallback fail, then the service will return category names in
+                 * the default language `en` for English.
+                 *
+                 * Language codes:
+                 * - English, default US - `en`
+                 * - French - `fr`
+                 * - German - `de`
+                 * - Japanese - `ja`
+                 * - Portuguese, default Brazil - `pt`
+                 * - Spanish - `es`
+                 */
+                language?: components["parameters"]["LanguageParam"];
                 /** The requested response format - either `json` or `pjson` (pretty json). */
                 f?: components["parameters"]["FormatParam"];
                 /**
-                 * The authentication token with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
+                 * The authentication token, created from an ArcGIS Location Platform account, with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
                  *
                  * The `token` parameter can be either an API Key or short-lived token. See
                  * [ArcGIS security
@@ -1305,10 +1450,61 @@ export interface operations {
                 categoryId: components["parameters"]["CategoryIdParam"];
             };
             query: {
+                /**
+                 * Determines whether icons are returned and the type of icon to use with a place or category.
+                 *
+                 * ![example icon](https://static.arcgis.com/icons/places/Zoo_48.png)
+                 *
+                 * Use this parameter to define the type of icon URL for a given place or
+                 * category. Place icons are available in the following formats:
+                 *
+                 * - `svg`
+                 * - `cim` ([Cartographic Information Model](https://developers.arcgis.com/documentation/glossary/cim-symbol/))
+                 * - `png` 48 x 48 pixels
+                 *
+                 * The SVG and CIM symbols default to 15 x 15 pixels but can be scaled
+                 * smoothly for display in larger UI elements or to emphasize these
+                 * features on a map. The PNG icons are provided as 48 x 48 pixels but for
+                 * map display the recommended size is 16 x 16 pixels.
+                 *
+                 * The default is `none` (no icon URL will be returned).
+                 */
+                icon?: components["parameters"]["IconParam"];
+                /**
+                 * Optional case-sensitive parameter to specify the preferred language to
+                 * use for category names.
+                 *
+                 * This query parameter uses language codes to specify the preferred
+                 * language. If not set, or if no translation is available, the default
+                 * behavior is to return category names in English.
+                 *
+                 * The language codes use the [CLDR](https://cldr.unicode.org/) (Common
+                 * Locale Data Repository) format string that uses a two letter language
+                 * code (e.g. "fr" for French) optionally followed by a two letter country
+                 * code (e.g. "fr-CA" for French in Canada).
+                 *
+                 * If an unsupported language code is used, then the service will attempt
+                 * to fall-back to the closest available language. This is done by
+                 * stripping regional and extension subtags to find a known language code.
+                 * For example, French Canadian (`fr-CA`) is unsupported so this falls back
+                 * to French `fr`.
+                 *
+                 * Should the fallback fail, then the service will return category names in
+                 * the default language `en` for English.
+                 *
+                 * Language codes:
+                 * - English, default US - `en`
+                 * - French - `fr`
+                 * - German - `de`
+                 * - Japanese - `ja`
+                 * - Portuguese, default Brazil - `pt`
+                 * - Spanish - `es`
+                 */
+                language?: components["parameters"]["LanguageParam"];
                 /** The requested response format - either `json` or `pjson` (pretty json). */
                 f?: components["parameters"]["FormatParam"];
                 /**
-                 * The authentication token with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
+                 * The authentication token, created from an ArcGIS Location Platform account, with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
                  *
                  * The `token` parameter can be either an API Key or short-lived token. See
                  * [ArcGIS security
@@ -1341,7 +1537,7 @@ export interface operations {
      * To perform the request, you must supply the `x` and `y` coordinates of
      * the point from which to search. Optionally, you can also specify the:
      *
-     * - Search radius (up to 10,000 meters)
+     * - Search radius (1 to 10,000 meters)
      * - Category IDs
      * - Search text
      *
@@ -1402,6 +1598,26 @@ export interface operations {
                  * The default `pageSize` is 10.
                  */
                 pageSize?: components["parameters"]["PageSizeParam"];
+                /**
+                 * Determines whether icons are returned and the type of icon to use with a place or category.
+                 *
+                 * ![example icon](https://static.arcgis.com/icons/places/Zoo_48.png)
+                 *
+                 * Use this parameter to define the type of icon URL for a given place or
+                 * category. Place icons are available in the following formats:
+                 *
+                 * - `svg`
+                 * - `cim` ([Cartographic Information Model](https://developers.arcgis.com/documentation/glossary/cim-symbol/))
+                 * - `png` 48 x 48 pixels
+                 *
+                 * The SVG and CIM symbols default to 15 x 15 pixels but can be scaled
+                 * smoothly for display in larger UI elements or to emphasize these
+                 * features on a map. The PNG icons are provided as 48 x 48 pixels but for
+                 * map display the recommended size is 16 x 16 pixels.
+                 *
+                 * The default is `none` (no icon URL will be returned).
+                 */
+                icon?: components["parameters"]["IconParam"];
                 /**
                  * Request results starting from the given offset.
                  *
@@ -1416,7 +1632,7 @@ export interface operations {
                 /** The requested response format - either `json` or `pjson` (pretty json). */
                 f?: components["parameters"]["FormatParam"];
                 /**
-                 * The authentication token with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
+                 * The authentication token, created from an ArcGIS Location Platform account, with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
                  *
                  * The `token` parameter can be either an API Key or short-lived token. See
                  * [ArcGIS security
@@ -1443,17 +1659,20 @@ export interface operations {
     /**
      * The `/places/within-extent` request searches for places within an extent (bounding box).
      *
-     * You must supply the `xmin`,
-     * `ymin`, `xmax` and `ymax` coordinates to define the extent. The maximum width
-     * and height of an extent that can be used in a search is 20,000 meters.
+     * You must supply the `xmin`, `ymin`, `xmax` and `ymax` coordinates to
+     * define the extent. The maximum width and height of an extent that can be
+     * used in a search is 20,000 meters. The width and height of an extent
+     * must be greater than 0 meters.
      *
-     * You can also provide multiple categories or search text to find specific types of places within the extent.
+     * You can also provide multiple categories or search text to find specific
+     * types of places within the extent.
      *
-     * The default number of places returned (`pageSize`) is 10. The maximum `pageSize` value is 20.
+     * The default number of places returned (`pageSize`) is 10. The maximum
+     * `pageSize` value is 20.
      *
-     * If the `pagination.nextUrl` property in the response is populated, then you can
-     * page through the results to return more places. The maximum number of
-     * places that can be paged to is 200.
+     * If the `pagination.nextUrl` property in the response is populated, then
+     * you can page through the results to return more places. The maximum
+     * number of places that can be paged to is 200.
      *
      * **Note**: You cannot permanently store places. Please see the [Terms of
      * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
@@ -1464,25 +1683,25 @@ export interface operations {
         parameters: {
             query: {
                 /**
-                 * The minimum x coordinate, or longitude, of the search extent.
+                 * The minimum x coordinate, or longitude, of the search extent, in WGS84 decimal degrees.
                  *
                  * This is the furthest _west_ that will be searched.
                  */
                 xmin: components["parameters"]["XMinParam"];
                 /**
-                 * The minimum y coordinate, or latitude, of the search extent.
+                 * The minimum y coordinate, or latitude, of the search extent, in WGS84 decimal degrees.
                  *
                  * This is the furthest _south_ that will be searched.
                  */
                 ymin: components["parameters"]["YMinParam"];
                 /**
-                 * The maximum x coordinate, or longitude, of the search extent.
+                 * The maximum x coordinate, or longitude, of the search extent, in WGS84 decimal degrees.
                  *
                  * This is the furthest _east_ that will be searched.
                  */
                 xmax: components["parameters"]["XMaxParam"];
                 /**
-                 * The maximum y coordinate, or latitude, of the search extent.
+                 * The maximum y coordinate, or latitude, of the search extent, in WGS84 decimal degrees.
                  *
                  * This is the furthest _north_ that will be searched.
                  */
@@ -1504,6 +1723,26 @@ export interface operations {
                 categoryIds?: components["parameters"]["CategoryIdsParam"];
                 /** Free search text for places against names, categories etc. */
                 searchText?: components["parameters"]["SearchTextParam"];
+                /**
+                 * Determines whether icons are returned and the type of icon to use with a place or category.
+                 *
+                 * ![example icon](https://static.arcgis.com/icons/places/Zoo_48.png)
+                 *
+                 * Use this parameter to define the type of icon URL for a given place or
+                 * category. Place icons are available in the following formats:
+                 *
+                 * - `svg`
+                 * - `cim` ([Cartographic Information Model](https://developers.arcgis.com/documentation/glossary/cim-symbol/))
+                 * - `png` 48 x 48 pixels
+                 *
+                 * The SVG and CIM symbols default to 15 x 15 pixels but can be scaled
+                 * smoothly for display in larger UI elements or to emphasize these
+                 * features on a map. The PNG icons are provided as 48 x 48 pixels but for
+                 * map display the recommended size is 16 x 16 pixels.
+                 *
+                 * The default is `none` (no icon URL will be returned).
+                 */
+                icon?: components["parameters"]["IconParam"];
                 /**
                  * The number of places that should be sent in the response for a single request.
                  *
@@ -1534,7 +1773,7 @@ export interface operations {
                 /** The requested response format - either `json` or `pjson` (pretty json). */
                 f?: components["parameters"]["FormatParam"];
                 /**
-                 * The authentication token with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
+                 * The authentication token, created from an ArcGIS Location Platform account, with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
                  *
                  * The `token` parameter can be either an API Key or short-lived token. See
                  * [ArcGIS security
@@ -1620,6 +1859,9 @@ export interface operations {
      * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
      *
      * **Note**: Query parameters are case-sensitive.
+     *
+     * **Note**: Can be used in conjunction with the [Basemap Styles service](https://developers.arcgis.com/rest/basemap-styles) to request additional attributes
+     * for places retrieved using the [Places for basemaps](https://developers.arcgis.com/documentation/mapping-apis-and-services/maps/places-for-basemaps) workflow.
      */
     placeIdGet: {
         parameters: {
@@ -1643,10 +1885,30 @@ export interface operations {
                  * above.
                  */
                 requestedFields: components["parameters"]["RequestedFieldsParam"];
+                /**
+                 * Determines whether icons are returned and the type of icon to use with a place or category.
+                 *
+                 * ![example icon](https://static.arcgis.com/icons/places/Zoo_48.png)
+                 *
+                 * Use this parameter to define the type of icon URL for a given place or
+                 * category. Place icons are available in the following formats:
+                 *
+                 * - `svg`
+                 * - `cim` ([Cartographic Information Model](https://developers.arcgis.com/documentation/glossary/cim-symbol/))
+                 * - `png` 48 x 48 pixels
+                 *
+                 * The SVG and CIM symbols default to 15 x 15 pixels but can be scaled
+                 * smoothly for display in larger UI elements or to emphasize these
+                 * features on a map. The PNG icons are provided as 48 x 48 pixels but for
+                 * map display the recommended size is 16 x 16 pixels.
+                 *
+                 * The default is `none` (no icon URL will be returned).
+                 */
+                icon?: components["parameters"]["IconParam"];
                 /** The requested response format - either `json` or `pjson` (pretty json). */
                 f?: components["parameters"]["FormatParam"];
                 /**
-                 * The authentication token with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
+                 * The authentication token, created from an ArcGIS Location Platform account, with the `premium:user:places` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the Places service.
                  *
                  * The `token` parameter can be either an API Key or short-lived token. See
                  * [ArcGIS security