@arcgis/core 5.0.0-next.70 → 5.0.0-next.72

package/rest/lastMileDelivery/types.d.ts

@@ -1,10 +1,15 @@
 
+/** @since 5.0 */
 export type AnalysisRegion = "europe" | "japan" | "korea" | "middle-east-and-africa" | "north-america" | "south-america" | "south-asia" | "thailand";
 
+/** @since 5.0 */
 export type DistanceUnits = "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards";
 
+/** @since 5.0 */
 export type RouteShape = "none" | "straight-line" | "true-shape-with-measures";
 
+/** @since 5.0 */
 export type TimeUnits = "days" | "hours" | "minutes" | "seconds";
 
+/** @since 5.0 */
 export type TimeZoneUsage = "geo-local" | "utc";

package/rest/layerSources/DynamicDataLayer.d.ts

@@ -10,18 +10,23 @@ import type { RasterDataSourceProperties } from "./RasterDataSource.js";
 import type { QueryTableDataSourceProperties } from "./QueryTableDataSource.js";
 import type { JoinTableDataSourceProperties } from "./JoinTableDataSource.js";
 
+/** @since 5.0 */
 export interface DynamicDataLayerProperties extends JSONSupportMixinProperties {
   /**
    * A table,
    * feature class, or raster that resides in a registered workspace (either a folder or geodatabase).
    * The data sources are not visible in the Services Directory by default. They may be viewed, published, and configured using
    * the ArcGIS Server Manager.
+   *
+   * @since 5.0
    */
   dataSource?: (JoinTableDataSourceProperties & { type: "join-table" }) | (QueryTableDataSourceProperties & { type: "query-table" }) | (RasterDataSourceProperties & { type: "raster" }) | (TableDataSourceProperties & { type: "table" });
   /**
    * Controls field visibility in the layer. Only specified fields will be visible.
    * If `null`, all fields are visible in the dynamic layer. The specification for a field object is
    * provided below.
+   *
+   * @since 5.0
    */
   fields?: FieldProperties[];
 }
@@ -35,11 +40,12 @@ export interface DynamicDataLayerProperties extends JSONSupportMixinProperties {
  *
  * Data source | Description
  * ------------|------------
- * [TableDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-layerSources-TableDataSource.html) | A feature class with geometries or table without geometries. When a table data source does not contain geometries, it may be used as one of the sources in a {@link rest/layerSources/DataLayerSource!JoinTableDataSource join operation}. Feature class tables may be used on their own since they contain a geometry field.
+ * [TableDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-layerSources-TableDataSource.html) | A feature class with geometries or table without geometries. When a table data source does not contain geometries, it may be used as one of the sources in a [join operation](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-layerSources-JoinTableDataSource.html). Feature class tables may be used on their own since they contain a geometry field.
  * [QueryTableDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-layerSources-QueryTableDataSource.html) | A feature class or table that may be queried on the fly with a SQL where clause. This data source is useful for scenarios where you have a table containing unique geometries and another table with multiple records that match to each geometry. You can use the QueryTableDataSource to select only a subset of those matching records (so records in both tables have a one-to-one relationship with each other) and join them to the table with geometries.
  * [RasterDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-layerSources-RasterDataSource.html) | A raster dataset used for visualization purposes only.
- * {@link rest/layerSources/DataLayerSource!JoinTableDataSource} | This data source consists of two data sources joined by a common attribute or key. The left table data source typically contains geometries, while the right source may be a table or query table without geometries.
+ * [JoinTableDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-layerSources-JoinTableDataSource.html) | This data source consists of two data sources joined by a common attribute or key. The left table data source typically contains geometries, while the right source may be a table or query table without geometries.
  *
+ * @since 5.0
  * @see [Sample - MapImageLayer: toggle sublayer visibility](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-sublayers/)
  * @see [Sample - MapImageLayer: dynamic data layer with table join](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-table-join/)
  * @see [Sample - MapImageLayer: dynamic data layer with query table](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-query-table/)
@@ -84,6 +90,8 @@ export default abstract class DynamicDataLayer extends JSONSupport {
    * feature class, or raster that resides in a registered workspace (either a folder or geodatabase).
    * The data sources are not visible in the Services Directory by default. They may be viewed, published, and configured using
    * the ArcGIS Server Manager.
+   *
+   * @since 5.0
    */
   get dataSource(): JoinTableDataSource | QueryTableDataSource | RasterDataSource | TableDataSource;
   set dataSource(value: (JoinTableDataSourceProperties & { type: "join-table" }) | (QueryTableDataSourceProperties & { type: "query-table" }) | (RasterDataSourceProperties & { type: "raster" }) | (TableDataSourceProperties & { type: "table" }));
@@ -91,12 +99,16 @@ export default abstract class DynamicDataLayer extends JSONSupport {
    * Controls field visibility in the layer. Only specified fields will be visible.
    * If `null`, all fields are visible in the dynamic layer. The specification for a field object is
    * provided below.
+   *
+   * @since 5.0
    */
   get fields(): Field[];
   set fields(value: FieldProperties[]);
   /**
    * This value is always `data-layer` and is inferred when
    * the `dataSource` property is set.
+   *
+   * @since 5.0
    */
   get type(): "data-layer";
 }

package/rest/layerSources/DynamicMapLayer.d.ts

@@ -1,5 +1,6 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface DynamicMapLayerProperties extends JSONSupportMixinProperties, Partial<Pick<DynamicMapLayer, "gdbVersion" | "mapLayerId">> {}
 
 /**
@@ -9,6 +10,7 @@ export interface DynamicMapLayerProperties extends JSONSupportMixinProperties, P
  * that point to the same service layer, but are assigned different definition
  * expressions, renderers, and other properties.
  *
+ * @since 5.0
  * @see [Sample - MapImageLayer: create dynamic map layers](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicmaplayer/)
  * @see [ArcGIS REST API - Dynamic map layer](https://developers.arcgis.com/rest/services-reference/enterprise/layer-source-object/#dynamic-map-layer)
  * @example
@@ -42,13 +44,23 @@ export interface DynamicMapLayerProperties extends JSONSupportMixinProperties, P
  * });
  */
 export default abstract class DynamicMapLayer extends JSONSupport {
-  /** An optional property for specifying the GDB version. */
+  /**
+   * An optional property for specifying the GDB version.
+   *
+   * @since 5.0
+   */
   accessor gdbVersion: string;
-  /** The [Sublayer#id](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#id) of the service sublayer. */
+  /**
+   * The [Sublayer#id](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#id) of the service sublayer.
+   *
+   * @since 5.0
+   */
   accessor mapLayerId: number;
   /**
    * This value is always `map-layer` and is inferred when
    * the `mapLayerId` property is set.
+   *
+   * @since 5.0
    */
   get type(): "map-layer";
 }

package/rest/layerSources/JoinTableDataSource.d.ts

@@ -2,14 +2,17 @@ import type DynamicDataLayer from "./DynamicDataLayer.js";
 import type DynamicMapLayer from "./DynamicMapLayer.js";
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface JoinTableDataSourceProperties extends JSONSupportMixinProperties, Partial<Pick<JoinTableDataSource, "joinType" | "leftTableKey" | "leftTableSource" | "rightTableKey" | "rightTableSource">> {}
 
+/** @since 5.0 */
 export type JoinType = "left-inner-join" | "left-outer-join";
 
 /**
  * The result of an on-the-fly join operation at runtime. Nested joins are supported.
  * To use nested joins, set either `leftTableSource` or `rightTableSource` to `join-table`.
  *
+ * @since 5.0
  * @see [Sample - MapImageLayer: dynamic data layer with table join](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-table-join/)
  * @see [ArcGIS REST API - Join table data source](https://developers.arcgis.com/rest/services-reference/enterprise/data-source-object/#join-table-data-source)
  * @example
@@ -51,25 +54,41 @@ export default abstract class JoinTableDataSource extends JSONSupport {
    * ---------------|------------
    * left-outer-join | Unmatched records in the left table source are preserved and joined with `null` values in the right table source.
    * left-inner-join | Records in the left table source are discarded if they are unmatched with records in the right table source.
+   *
+   * @since 5.0
    */
   joinType: JoinType;
   /**
    * The field name used for joining or matching records in the left table to
    * records in the right table.
+   *
+   * @since 5.0
    */
   accessor leftTableKey: string;
-  /** The left table for joining to the right table source. This can either be a dynamic map layer or a dynamic data layer. The dynamic data layer may contain another join data source used for nested joining. */
+  /**
+   * The left table for joining to the right table source. This can either be a dynamic map layer or a dynamic data layer. The dynamic data layer may contain another join data source used for nested joining.
+   *
+   * @since 5.0
+   */
   accessor leftTableSource: DynamicMapLayer | DynamicDataLayer;
   /**
    * The field name used for joining or matching records in the right table
    * to records in the left table.
+   *
+   * @since 5.0
    */
   accessor rightTableKey: string;
-  /** The right table for joining to the left table source. This can either be a dynamic map layer or a dynamic data layer. The dynamic data layer may contain another join data source used for nested joining. */
+  /**
+   * The right table for joining to the left table source. This can either be a dynamic map layer or a dynamic data layer. The dynamic data layer may contain another join data source used for nested joining.
+   *
+   * @since 5.0
+   */
   accessor rightTableSource: DynamicMapLayer | DynamicDataLayer;
   /**
    * This value is always `join-table` and is inferred when other
    * join table properties of this object are set.
+   *
+   * @since 5.0
    */
   get type(): "join-table";
 }

package/rest/layerSources/QueryTableDataSource.d.ts

@@ -3,8 +3,13 @@ import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSup
 import type { FeatureGeometryType } from "../../geometry/types.js";
 import type { SpatialReferenceProperties } from "../../geometry/SpatialReference.js";
 
+/** @since 5.0 */
 export interface QueryTableDataSourceProperties extends JSONSupportMixinProperties, Partial<Pick<QueryTableDataSource, "geometryType" | "oidFields" | "query" | "workspaceId">> {
-  /** The spatial reference of the geometry of each feature in the table source. */
+  /**
+   * The spatial reference of the geometry of each feature in the table source.
+   *
+   * @since 5.0
+   */
   spatialReference?: SpatialReferenceProperties;
 }
 
@@ -22,6 +27,7 @@ export interface QueryTableDataSourceProperties extends JSONSupportMixinProperti
  * and join them to the table with geometries
  * so records in both tables have a one-to-one relationship with each other.
  *
+ * @since 5.0
  * @see [Sample - MapImageLayer: dynamic data layer with query table](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-query-table/)
  * @see [ArcGIS REST API - Query table data source](https://developers.arcgis.com/rest/services-reference/enterprise/data-source-object/#query-table-data-source)
  * @example
@@ -43,25 +49,46 @@ export interface QueryTableDataSourceProperties extends JSONSupportMixinProperti
  * });
  */
 export default class QueryTableDataSource extends JSONSupport {
+  /** @since 5.0 */
   constructor(properties?: QueryTableDataSourceProperties);
-  /** The geometry type of each record in the table. */
+  /**
+   * The geometry type of each record in the table.
+   *
+   * @since 5.0
+   */
   geometryType: FeatureGeometryType;
   /**
    * The field name(s) containing the unique IDs for each
    * record in the table. This can be a comma separated list if the query table is used
-   * in a {@link rest/layerSources/DataLayerSource!JoinTableDataSource JoinTableDataSource}.
+   * in a [JoinTableDataSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-layerSources-JoinTableDataSource.html).
+   *
+   * @since 5.0
    */
   accessor oidFields: string;
-  /** The SQL query used to filter records. */
+  /**
+   * The SQL query used to filter records.
+   *
+   * @since 5.0
+   */
   accessor query: string;
-  /** The spatial reference of the geometry of each feature in the table source. */
+  /**
+   * The spatial reference of the geometry of each feature in the table source.
+   *
+   * @since 5.0
+   */
   get spatialReference(): SpatialReference;
   set spatialReference(value: SpatialReferenceProperties);
   /**
    * This value is always `query-table` and
    * is inferred when the `query` property of this object is set.
+   *
+   * @since 5.0
    */
   get type(): "query-table";
-  /** The workspace where the data resides (defined in ArcGIS Server Manager). */
+  /**
+   * The workspace where the data resides (defined in ArcGIS Server Manager).
+   *
+   * @since 5.0
+   */
   accessor workspaceId: string;
 }

package/rest/layerSources/RasterDataSource.d.ts

@@ -1,11 +1,13 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface RasterDataSourceProperties extends JSONSupportMixinProperties, Partial<Pick<RasterDataSource, "dataSourceName" | "workspaceId">> {}
 
 /**
  * A file-based raster that resides in a registered raster workspace. The raster may
  * only be displayed in the view, not queried or assigned a renderer.
  *
+ * @since 5.0
  * @see [Sample - MapImageLayer: raster data source](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-raster/)
  * @see [ArcGIS REST API - Raster data source](https://developers.arcgis.com/rest/services-reference/enterprise/data-source-object/#raster-data-source)
  * @example
@@ -26,10 +28,22 @@ export interface RasterDataSourceProperties extends JSONSupportMixinProperties,
  * });
  */
 export default abstract class RasterDataSource extends JSONSupport {
-  /** The name of the raster in the registered workspace. */
+  /**
+   * The name of the raster in the registered workspace.
+   *
+   * @since 5.0
+   */
   accessor dataSourceName: string;
-  /** This value is always `raster`. */
+  /**
+   * This value is always `raster`.
+   *
+   * @since 5.0
+   */
   get type(): "raster";
-  /** The workspace where the raster resides as defined in the ArcGIS Server Manager. */
+  /**
+   * The workspace where the raster resides as defined in the ArcGIS Server Manager.
+   *
+   * @since 5.0
+   */
   accessor workspaceId: string;
 }

package/rest/layerSources/TableDataSource.d.ts

@@ -1,5 +1,6 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface TableDataSourceProperties extends JSONSupportMixinProperties, Partial<Pick<TableDataSource, "dataSourceName" | "gdbVersion" | "workspaceId">> {}
 
 /**
@@ -7,6 +8,7 @@ export interface TableDataSourceProperties extends JSONSupportMixinProperties, P
  * In the case of a geodatabase, if versioned, use `version` to
  * switch to an alternate geodatabase version.
  *
+ * @since 5.0
  * @see [Sample - MapImageLayer: toggle sublayer visibility](https://developers.arcgis.com/javascript/latest/sample-code/layers-mapimagelayer-sublayers/)
  * @see [Sample - MapImageLayer: dynamic data layer with table join](https://developers.arcgis.com/javascript/latest/sample-code/layers-dynamicdatalayer-table-join/)
  * @see [ArcGIS REST API - Table data source](https://developers.arcgis.com/rest/services-reference/enterprise/data-source-object/#table-data-source)
@@ -27,12 +29,28 @@ export interface TableDataSourceProperties extends JSONSupportMixinProperties, P
  *  });
  */
 export default abstract class TableDataSource extends JSONSupport {
-  /** The name of the table in the registered workspace. */
+  /**
+   * The name of the table in the registered workspace.
+   *
+   * @since 5.0
+   */
   accessor dataSourceName: string;
-  /** References the geodatabase version if multiple versions exist in the geodatabase. */
+  /**
+   * References the geodatabase version if multiple versions exist in the geodatabase.
+   *
+   * @since 5.0
+   */
   accessor gdbVersion: string;
-  /** This value is always `table`. */
+  /**
+   * This value is always `table`.
+   *
+   * @since 5.0
+   */
   get type(): "table";
-  /** The workspace where the table resides as defined in the ArcGIS Server Manager. */
+  /**
+   * The workspace where the table resides as defined in the ArcGIS Server Manager.
+   *
+   * @since 5.0
+   */
   accessor workspaceId: string;
 }

package/rest/networks/circuits/support/ExportCircuitsParameters.d.ts

@@ -1,15 +1,22 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../../../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface ExportCircuitsParametersProperties extends JSONSupportMixinProperties, Partial<Pick<ExportCircuitsParameters, "circuits" | "exportAcknowledgement">> {}
 
+/** @since 5.0 */
 export default abstract class ExportCircuitsParameters extends JSONSupport {
-  /** The names of the circuit or circuits to be exported. */
+  /**
+   * The names of the circuit or circuits to be exported.
+   *
+   * @since 5.0
+   */
   accessor circuits: string[];
   /**
    * Specifies whether the export is acknowledged.
    *   If true, the default version is required for the utility network's `gdbVersion`.
    *
    * @default false
+   * @since 5.0
    */
   accessor exportAcknowledgement: boolean;
 }

package/rest/networks/circuits/support/QueryCircuitsParameters.d.ts

@@ -2,22 +2,37 @@ import type CircuitLocation from "../../../../networks/support/CircuitLocation.j
 import type { JSONSupport, JSONSupportMixinProperties } from "../../../../core/JSONSupport.js";
 import type { CircuitLocationProperties } from "../../../../networks/support/CircuitLocation.js";
 
+/** @since 5.0 */
 export interface QueryCircuitsParametersProperties extends JSONSupportMixinProperties, Partial<Pick<QueryCircuitsParameters, "locationType" | "returnConsumerCircuits">> {
-  /** The start or stop location of the circuit to query. */
+  /**
+   * The start or stop location of the circuit to query.
+   *
+   * @since 5.0
+   */
   location?: CircuitLocationProperties | null;
 }
 
+/** @since 5.0 */
 export default abstract class QueryCircuitsParameters extends JSONSupport {
-  /** The start or stop location of the circuit to query. */
+  /**
+   * The start or stop location of the circuit to query.
+   *
+   * @since 5.0
+   */
   get location(): CircuitLocation | null | undefined;
   set location(value: CircuitLocationProperties | null | undefined);
-  /** The type of location to query circuits by. */
+  /**
+   * The type of location to query circuits by.
+   *
+   * @since 5.0
+   */
   accessor locationType: "start" | "stop" | "all" | null | undefined;
   /**
    * If false, returns only the immediate circuits passing through
    *   the specified location. Otherwise, returns all the circuits that consume the immediate circuits.
    *
    * @default false
+   * @since 5.0
    */
   accessor returnConsumerCircuits: boolean;
 }

package/rest/networks/support/QueryNamedTraceConfigurationsParameters.d.ts

@@ -1,14 +1,32 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface QueryNamedTraceConfigurationsParametersProperties extends JSONSupportMixinProperties, Partial<Pick<QueryNamedTraceConfigurationsParameters, "creators" | "globalIds" | "names" | "tags">> {}
 
+/** @since 5.0 */
 export default abstract class QueryNamedTraceConfigurationsParameters extends JSONSupport {
-  /** An array of the named trace configuration creators to be queried. */
+  /**
+   * An array of the named trace configuration creators to be queried.
+   *
+   * @since 5.0
+   */
   accessor creators: string[];
-  /** An array of named trace configuration globalIds (UUID) to be queried. */
+  /**
+   * An array of named trace configuration globalIds (UUID) to be queried.
+   *
+   * @since 5.0
+   */
   accessor globalIds: string[];
-  /** An array of named trace configuration names to be queried. */
+  /**
+   * An array of named trace configuration names to be queried.
+   *
+   * @since 5.0
+   */
   accessor names: string[];
-  /** An array of named trace configuration user tags to be queried. */
+  /**
+   * An array of named trace configuration user tags to be queried.
+   *
+   * @since 5.0
+   */
   accessor tags: string[];
 }

package/rest/print.d.ts

@@ -46,7 +46,7 @@
  * > Printing layers with non-standard URLs (e.g. no MapServer, FeatureServer, or ImageServer in the URL) requires ArcGIS Server 10.9.1 or later.
  * > Printing layers with supported [blendModes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) requires ArcGIS Server 10.9.1 or later. This is the list of currently supported types:
  * > `"color-burn"`, `"color-dodge"`, `"color"`, `"darken"`, `"difference"`, `"exclusion"`, `"hard-light"`, `"hue"`, `"lighten"`, `"luminosity"`, `"multiply"`, `"normal"`, `"overlay"`, `"saturation"`, `"screen"`, `"soft-light"`.
- * > Printing highlighted features with [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html) with {@link layers/FeatureLayer#highlight FeatureLayers} requires ArcGIS Server 11.4.0 or higher.
+ * > Printing highlighted features with [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html) with [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#highlight) requires ArcGIS Server 11.4.0 or higher.
  * > For printing [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) the catalog footprint is sent as a feature collection if the ArcGIS Server version is less than 11.3.1.
  * > Otherwise, it's sent as a CatalogLayer with the `dynamicGroupLayer` visibility set to `false`. The other layers from the CatalogLayer are sent separately.
  * >

package/rest/query/support/AttachmentInfo.d.ts

@@ -40,7 +40,7 @@ export default class AttachmentInfo extends JSONSupport {
    * for more information on supported attachment types.
    */
   accessor contentType: string;
-  /** An array of {@link layers/support/exifUtils!ExifInfo} for the attachment. */
+  /** An array of [ExifInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#ExifInfo) for the attachment. */
   accessor exifInfo: ExifInfo[] | null | undefined;
   /** The global identifier for the attachment. */
   accessor globalId: string;

package/rest/support/AddressToLocationsParameters.d.ts

@@ -7,26 +7,34 @@ import type { PointProperties } from "../../geometry/Point.js";
 import type { SpatialReferenceProperties } from "../../geometry/SpatialReference.js";
 import type { ExtentProperties } from "../../geometry/Extent.js";
 
+/** @since 5.0 */
 export interface AddressToLocationsParametersProperties extends JSONSupportMixinProperties, Partial<Pick<AddressToLocationsParameters, "address" | "categories" | "countryCode" | "forStorage" | "locationType" | "magicKey" | "maxLocations" | "outFields">> {
   /**
    * Used to weight returned results for a specified area.
    * Only used when the scale of the [MapView#scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) or
    * [SceneView#scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) is less than or equal to 300,000.
+   *
+   * @since 5.0
    */
   location?: PointProperties | null;
   /**
    * The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of
    * the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if
    * finding locations by address.
+   *
+   * @since 5.0
    */
   outSpatialReference?: SpatialReferenceProperties | null;
   /**
    * Defines the extent within which the geocode server will search.
    * Requires ArcGIS Server version 10.1 or greater.
+   *
+   * @since 5.0
    */
   searchExtent?: ExtentProperties | null;
 }
 
+/** @since 5.0 */
 export default abstract class AddressToLocationsParameters extends JSONSupport {
   /**
    * The address argument is data object that contains properties representing the various
@@ -57,55 +65,83 @@ export default abstract class AddressToLocationsParameters extends JSONSupport {
    * The Services Directory can be used to find out the required and optional address fields
    * and the correct names for the input name fields. If you are using the World Geocoding Service
    * visit the ArcGIS Online Geocoding Service help for more details on the World Geocoder.
+   *
+   * @since 5.0
    */
   accessor address: any;
   /**
    * Limit result to one or more categories. For example,
    * "Populated Place" or "Scandinavian Food". Only applies to the World Geocode Service.
    * See [Category filtering (World Geocoding Service)](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm#ESRI_SECTION1_502B3FE2028145D7B189C25B1A00E17B) for more information.
+   *
+   * @since 5.0
    */
   accessor categories: string[] | null | undefined;
   /**
    * Limit result to a specific country. For example, "US" for United States or "SE" for Sweden.
    * Only applies to the World Geocode Service. See Geocode coverage (World Geocoding Service)
    * for more information.
+   *
+   * @since 5.0
    */
   accessor countryCode: string | null;
-  /** Allows the results of single geocode transactions to be persisted. */
+  /**
+   * Allows the results of single geocode transactions to be persisted.
+   *
+   * @since 5.0
+   */
   accessor forStorage: boolean | null;
   /**
    * Used to weight returned results for a specified area.
    * Only used when the scale of the [MapView#scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) or
    * [SceneView#scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale) is less than or equal to 300,000.
+   *
+   * @since 5.0
    */
   get location(): Point | null | undefined;
   set location(value: PointProperties | null | undefined);
   /**
    * Define the type of location, either `"street"` or `"rooftop"`, of the point returned from the
    * [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm).
+   *
+   * @since 5.0
    */
   accessor locationType: LocationType | null | undefined;
-  /** A `suggestLocations` result ID (magicKey). Used to query for a specific results information. */
+  /**
+   * A `suggestLocations` result ID (magicKey). Used to query for a specific results information.
+   *
+   * @since 5.0
+   */
   accessor magicKey: string | null | undefined;
-  /** Maximum results to return from the query. */
+  /**
+   * Maximum results to return from the query.
+   *
+   * @since 5.0
+   */
   accessor maxLocations: number | null | undefined;
   /**
    * The list of fields included in the returned result set. This list is a comma delimited
    * list of field names. If you specify the shape field in the list of return fields, it is ignored.
    * For non-intersection addresses you can specify the candidate fields as defined in the geocode
    * service. For intersection addresses you can specify the intersection candidate fields.
+   *
+   * @since 5.0
    */
   accessor outFields: string[] | null | undefined;
   /**
    * The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of
    * the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if
    * finding locations by address.
+   *
+   * @since 5.0
    */
   get outSpatialReference(): SpatialReference | null | undefined;
   set outSpatialReference(value: SpatialReferenceProperties | null | undefined);
   /**
    * Defines the extent within which the geocode server will search.
    * Requires ArcGIS Server version 10.1 or greater.
+   *
+   * @since 5.0
    */
   get searchExtent(): Extent | null | undefined;
   set searchExtent(value: ExtentProperties | null | undefined);

package/rest/support/AddressesToLocationsParameters.d.ts

@@ -3,15 +3,19 @@ import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSup
 import type { LocationType } from "../types.js";
 import type { SpatialReferenceProperties } from "../../geometry/SpatialReference.js";
 
+/** @since 5.0 */
 export interface AddressesToLocationsParametersProperties extends JSONSupportMixinProperties, Partial<Pick<AddressesToLocationsParameters, "addresses" | "categories" | "countryCode" | "locationType">> {
   /**
    * The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of
    * the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if
    * finding locations by address.
+   *
+   * @since 5.0
    */
   outSpatialReference?: SpatialReferenceProperties | null;
 }
 
+/** @since 5.0 */
 export default abstract class AddressesToLocationsParameters extends JSONSupport {
   /**
    * The input addresses in the format supported by the geocode service. If the service supports
@@ -22,28 +26,38 @@ export default abstract class AddressesToLocationsParameters extends JSONSupport
    *   "Single Line Input":"77 Main St, Plymouth, NH 03264"
    * }
    * ```
+   *
+   * @since 5.0
    */
   accessor addresses: any[] | null;
   /**
    * Limit result to one or more categories. For example,
    * "Populated Place" or "Scandinavian Food". Only applies to the World Geocode Service.
    * See [Category filtering (World Geocoding Service)](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm#ESRI_SECTION1_502B3FE2028145D7B189C25B1A00E17B) for more information.
+   *
+   * @since 5.0
    */
   accessor categories: string[] | null;
   /**
    * Limits the results to only search in the country provided. For example `US` for United States or `SE` for Sweden. Only applies to the
    * World Geocode Service. See the [World Geocoding Service documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm) for more information.
+   *
+   * @since 5.0
    */
   accessor countryCode: string | null;
   /**
    * Define the type of location, either `"street"` or `"rooftop"`, of the point returned from the
    * [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm).
+   *
+   * @since 5.0
    */
   accessor locationType: LocationType | null;
   /**
    * The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of
    * the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if
    * finding locations by address.
+   *
+   * @since 5.0
    */
   get outSpatialReference(): SpatialReference | null;
   set outSpatialReference(value: SpatialReferenceProperties | null);