@evergis/api 3.0.49 → 3.0.50

package/dist/__generated__/IceRouterService.d.ts

@@ -0,0 +1,31 @@
+import { IceRouterResultDc, IceRouteTaskDc } from './data-contracts';
+import { Service } from './Service';
+/**
+ * @title Spatial Processing Core API
+ * @version v0.6.0
+ * @baseUrl /sp
+ */
+export declare class IceRouterService extends Service {
+    /**
+     * No description
+     *
+     * @tags IceRouter
+     * @name StartTask
+     * @operationId IceRouterController_StartTask
+     * @summary Start route build between start and end points.
+     * @request POST:/ice-router/tasks
+     * @response `200` Success
+     */
+    startTask(data: IceRouteTaskDc): Promise<string>;
+    /**
+     * No description
+     *
+     * @tags IceRouter
+     * @name GetResult
+     * @operationId IceRouterController_GetResult
+     * @summary Get task result.
+     * @request GET:/ice-router/tasks/{id}
+     * @response `200` Success
+     */
+    getResult(id: string): Promise<IceRouterResultDc>;
+}

package/dist/__generated__/data-contracts.d.ts

@@ -32,8 +32,7 @@ export interface AggregationDataResultDc {
     /** Aggregation attribute name. */
     aggregationAttributeName: string;
     /**
-     * The type of aggregation function for storage query.
-     * The aggregation is applied to the source attribute and the result will write in the target attribute.
+     *
      *
      * None
      *
@@ -58,8 +57,7 @@ export interface AggregationDataResultDc {
     value: any;
 }
 /**
-* The type of aggregation function for storage query.
-The aggregation is applied to the source attribute and the result will write in the target attribute.
+*
 
 None
 
@@ -99,8 +97,7 @@ export interface AggregationSettingDc {
     /** Source attribute name. */
     sourceAttributeName: string;
     /**
-     * The type of aggregation function for storage query.
-     * The aggregation is applied to the source attribute and the result will write in the target attribute.
+     *
      *
      * None
      *
@@ -176,7 +173,7 @@ export interface ArgumentDefinitionDc {
     defaultValue?: any;
     isOptional?: boolean;
     /**
-     * Type of the geometry.
+     *
      *
      * unknown
      *
@@ -315,8 +312,7 @@ export interface AttributeConfigurationDc {
     /** If false, attribute will not be returned in feature query. */
     isDisplayed?: boolean;
     /**
-     * The type of aggregation function for storage query.
-     * The aggregation is applied to the source attribute and the result will write in the target attribute.
+     *
      *
      * None
      *
@@ -1738,7 +1734,6 @@ export interface GeocodeResultDc {
      * @format double
      */
     score?: number;
-    /** Geometry without specified spatial reference. */
     geometry?: IGeometry;
 }
 /**
@@ -1755,7 +1750,7 @@ export interface GeocodeSuggestResultDc {
  */
 export interface GeometryDc {
     /**
-     * Type of the geometry.
+     *
      *
      * unknown
      *
@@ -1777,7 +1772,7 @@ export interface GeometryDc {
     sr?: number;
 }
 /**
-* Type of the geometry.
+*
 
 unknown
 
@@ -1897,72 +1892,97 @@ export declare enum HttpStatusCode {
     NetworkAuthenticationRequired = "NetworkAuthenticationRequired"
 }
 /**
- * Geographic spatial reference (e.g. with lat/long coordinates).
+ * Attributes provides by router to describe route.
  */
-export interface IDatum {
+export interface IceRouteAttributesDc {
+    /** Gets route builder mode. */
+    type?: string;
+    /** Gets route title. */
+    title?: string;
     /**
-     * Semimajor axis length.
+     * Gets route build time.
      * @format double
      */
-    semimajor?: number;
+    time?: number;
     /**
-     * Inverse flattening.
+     * Gets route distance.
      * @format double
      */
-    inverseFlattening?: number;
+    distance?: number;
+}
+/**
+ * Provides description of result of ice router.
+ */
+export interface IceRouteDc {
+    /** Attributes provides by router to describe route. */
+    attributes?: IceRouteAttributesDc;
+    /** Route geometry. */
+    geometry?: IceRouteGeometryDc;
+}
+/**
+ * Route geometry.
+ */
+export interface IceRouteGeometryDc {
+    /** Gets type of geometry. */
+    type?: string;
+    /** Gets polyline coordinates. */
+    coordinates?: number[][];
+}
+/**
+ * Provides result of ice route builder.
+ */
+export interface IceRouterResultDc {
+    /** Gets status the task is done. */
+    isDone?: boolean;
     /**
-     * Semiminor axis length.
-     * @format double
+     * Gets list of the result tasks. Provides with status "completed".
+     * <br>
+     * Routes array contains three routes of types.
+     * 1. Economic.
+     * 2. Optimum.
+     * 3. Fast.
+     *
      */
+    routes?: IceRouteDc[];
+}
+/**
+ * Data contract to start ice routing task.
+ */
+export interface IceRouteTaskDc {
+    /** Gets or sets start point. */
+    start: number[];
+    /** Gets or sets end point. */
+    end: number[];
+}
+export interface IDatum {
+    /** @format double */
+    semimajor?: number;
+    /** @format double */
+    inverseFlattening?: number;
+    /** @format double */
     semiminor?: number;
-    /**
-     * Flattening value.
-     * @format double
-     */
+    /** @format double */
     flattening?: number;
-    /** If true longitude is the first coordinate, if false latitude is the first coordinate. */
     reversedOrder?: boolean;
-    /**
-     * Numerical ID of the spatial reference as given by the publishing authority. E.g. for EPSG:3857 id is '3857'.
-     * @format int32
-     */
+    /** @format int32 */
     id?: number;
-    /** Publishing authority of the spatial reference. E.g. EPSG or OSG. */
     authority?: string;
-    /** Human readable description of the spatial reference. */
     description?: string;
-    /** Well known text as specified by http://docs.opengeospatial.org/is/12-063r5/12-063r5.html. */
     wkt?: string;
-    /**
-     * Number of coordinate dimensions in this spatial reference.
-     * @format int32
-     */
+    /** @format int32 */
     dimensions?: number;
-    /** Geographic spatial reference (e.g. with lat/long coordinates). */
     datum?: IDatum;
 }
-/**
- * A pair of points that represent a rectangular area in the space.
- */
 export interface IEnvelopeGeometry {
-    /** Double values vector. */
     start?: IVector;
-    /** Double values vector. */
     end?: IVector;
-    /**
-     * Width of the envelope.
-     * @format double
-     */
+    /** @format double */
     width?: number;
-    /**
-     * Height of the envelope.
-     * @format double
-     */
+    /** @format double */
     height?: number;
-    /** Double values vector. */
     centroid?: IVector;
     /**
-     * Type of the geometry.
+     *
      *
      * unknown
      *
@@ -1977,19 +1997,13 @@ export interface IEnvelopeGeometry {
      * multipoint
      */
     geometryType?: GeometryType;
-    /** Spatial reference is an object that specifies the geodetic datum and projection parameters of the coordinate system in use. */
     sr?: ISpatialReference;
-    /** A pair of points that represent a rectangular area in the space. */
     envelope?: IEnvelopeGeometry;
 }
-/**
- * Geometry without specified spatial reference.
- */
 export interface IGeometry {
-    /** Double values vector. */
     centroid?: IVector;
     /**
-     * Type of the geometry.
+     *
      *
      * unknown
      *
@@ -2004,9 +2018,7 @@ export interface IGeometry {
      * multipoint
      */
     geometryType?: GeometryType;
-    /** Spatial reference is an object that specifies the geodetic datum and projection parameters of the coordinate system in use. */
     sr?: ISpatialReference;
-    /** A pair of points that represent a rectangular area in the space. */
     envelope?: IEnvelopeGeometry;
 }
 export interface ILineEndingDc {
@@ -2089,27 +2101,14 @@ export interface IServiceConfiguration {
     /** Type of the layer. */
     type?: string;
 }
-/**
- * Spatial reference is an object that specifies the geodetic datum and projection parameters of the coordinate system in use.
- */
 export interface ISpatialReference {
-    /**
-     * Numerical ID of the spatial reference as given by the publishing authority. E.g. for EPSG:3857 id is '3857'.
-     * @format int32
-     */
+    /** @format int32 */
     id?: number;
-    /** Publishing authority of the spatial reference. E.g. EPSG or OSG. */
     authority?: string;
-    /** Human readable description of the spatial reference. */
     description?: string;
-    /** Well known text as specified by http://docs.opengeospatial.org/is/12-063r5/12-063r5.html. */
     wkt?: string;
-    /**
-     * Number of coordinate dimensions in this spatial reference.
-     * @format int32
-     */
+    /** @format int32 */
     dimensions?: number;
-    /** Geographic spatial reference (e.g. with lat/long coordinates). */
     datum?: IDatum;
 }
 /**
@@ -2121,14 +2120,8 @@ export interface IValidationError {
     /** Validation errors. */
     message?: string;
 }
-/**
- * Double values vector.
- */
 export interface IVector {
-    /**
-     * Number of coordinates dimensions.
-     * @format int32
-     */
+    /** @format int32 */
     dimensions?: number;
 }
 /**
@@ -2200,7 +2193,7 @@ export interface LayerDefinitionDc {
     /** The name of the attribute that is used for assigning geometry value for the feature. */
     geometryAttribute: string;
     /**
-     * Type of the geometry.
+     *
      *
      * unknown
      *
@@ -2278,7 +2271,6 @@ Includes ids of modified features and their bbox.
 export interface LayerUpdateInfoDc {
     /** Updated layer service name. */
     layerServiceName: string;
-    /** A pair of points that represent a rectangular area in the space. */
     boundingBox?: IEnvelopeGeometry;
     /** Array of created ids. */
     createdIds?: ObjectId[];
@@ -2644,7 +2636,7 @@ export interface NewResourcesTypesDc {
  */
 export declare type ObjectId = object;
 /**
-* Boolean operation between polygons.
+*
 
 Unknown
 
@@ -3150,9 +3142,6 @@ export declare type RasterSymbolDc = SymbolDc & {
     type?: string;
     opacity?: CalculatedParameterDc;
 };
-/**
- * Geometrical rectangle.
- */
 export interface Rectangle2 {
     /** @format double */
     x1?: number;
@@ -3162,19 +3151,11 @@ export interface Rectangle2 {
     x2?: number;
     /** @format double */
     y2?: number;
-    /**
-     * Width of the rectangle.
-     * @format double
-     */
+    /** @format double */
     width?: number;
-    /**
-     * Height of the rectangle.
-     * @format double
-     */
+    /** @format double */
     height?: number;
-    /** Double values vector. */
     center?: IVector;
-    /** Double values vector. */
     halfSize?: IVector;
 }
 /**
@@ -3230,8 +3211,8 @@ export interface RemoteTileServiceInfo {
  * Service info for a tile service.
  */
 export declare type RemoteTileServiceInfoDc = TileServiceInfoDc & {
-    sourceUrl: string;
-    sourceUrlMask: string;
+    sourceUrl?: string;
+    sourceUrlMask?: string;
     sourceServers?: string[];
     copyrightText?: string;
 };
@@ -3609,7 +3590,7 @@ export interface ServiceInfoPubDc {
      */
     condition?: string;
     /**
-     * Type of the geometry.
+     *
      *
      * unknown
      *
@@ -3732,7 +3713,7 @@ export interface ServiceListItemDc {
      */
     condition?: string;
     /**
-     * Type of the geometry.
+     *
      *
      * unknown
      *
@@ -4404,9 +4385,7 @@ export declare type TileCatalogTableConfigurationDc = TableConfigurationBaseDc &
  * Tile info structure.
  */
 export interface TileInfo {
-    /** Double values vector. */
     origin?: IVector;
-    /** Geometrical rectangle. */
     boundingRectangle?: Rectangle2;
     /**
      * If set to true, the origin point will be considered to be the bottom left corner and increasing tile indexes increase
@@ -4431,7 +4410,6 @@ export interface TileInfo {
     width?: number;
     /** Image format. */
     format?: string;
-    /** Spatial reference is an object that specifies the geodetic datum and projection parameters of the coordinate system in use. */
     spatialReference?: ISpatialReference;
     /** List of levels of detail that define the tiling schema. */
     lods?: LodInfo[];
@@ -5056,21 +5034,12 @@ export interface VariableValueInfo {
     /** Gets or sets roles. */
     roles?: string[];
 }
-/**
- * 2-dimensional vector.
- */
 export interface Vector2 {
     /** @format int32 */
     dimensions?: number;
-    /**
-     * First coordinate.
-     * @format double
-     */
+    /** @format double */
     x?: number;
-    /**
-     * Second coordinate.
-     * @format double
-     */
+    /** @format double */
     y?: number;
 }
 /**
@@ -5122,7 +5091,7 @@ export interface WorkspaceLimitsDc {
     currentProjectCount?: number;
 }
 export interface GetUsersParams {
-    /** String filter for the user name (uses % and _ wild cards like SQL). */
+    /** String filter for the user (uses % and _ wild cards like SQL). */
     filter?: string;
     /** Ordering property name. */
     orderBy?: string;
@@ -5144,7 +5113,7 @@ export interface GetUsersParams {
     roles?: string[];
 }
 export interface GetExtendedUsersParams {
-    /** String filter for the user name (uses % and _ wild cards like SQL). */
+    /** String filter for the user (uses % and _ wild cards like SQL). */
     filter?: string;
     /** Ordering property name. */
     orderBy?: string;
@@ -5215,8 +5184,10 @@ export interface ResetPasswordCallbackPayload {
     newPassword: string;
 }
 export interface GetRolesParams {
-    /** String filter for the role name (uses % and _ wild cards like SQL). */
+    /** String filter for the role (uses % and _ wild cards like SQL). */
     filter?: string;
+    /** String filter for the user (uses % and _ wild cards like SQL). */
+    userFilter?: string;
     /** Ordering property name. */
     orderBy?: string;
     /** Include system roles (starts from '__'). */