@evergis/api 5.0.7 → 5.0.9-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -251,111 +251,17 @@ export type ArcGisDataSourceInfoDc = DataSourceInfoDc & {
251
251
  */
252
252
  export interface AttributeConfigurationDc {
253
253
  /**
254
- * The name of the attribute.
255
- * @minLength 1
256
- */
257
- attributeName: string;
258
- /** The name of the column in the data table that holds the attribute values. */
259
- columnName?: string;
260
- /** Human-friendly name for the attribute. */
261
- alias?: string;
262
- /** Description for the attribute. */
263
- description?: string;
264
- /**
265
- *
266
- *
267
- * None
268
- *
269
- * Image
270
- *
271
- * PkkCode
272
- *
273
- * Attachments
274
- */
275
- subType?: StringSubType;
276
- /** If set to false, editing of the attribute value will be prohibited. */
277
- isEditable?: boolean;
278
- /** If false, attribute will not be returned in feature query. */
279
- isDisplayed?: boolean;
280
- /**
281
- *
282
- *
283
- * None
284
- *
285
- * Array
286
- *
287
- * Min
288
- *
289
- * Max
290
- *
291
- * Avg
292
- *
293
- * Sum
294
- *
295
- * Extent
296
- *
297
- * H3
298
- *
299
- * Count
300
- *
301
- * TotalCount
302
- *
303
- * DistinctCount
254
+ * Attribute configuration type.
304
255
  *
305
- * First
306
- *
307
- * Last
308
- *
309
- * Median
310
- *
311
- * Mod
312
- *
313
- * StdDeviation
314
- *
315
- * SumOfProduct
316
- *
317
- * OnlyValue
318
- *
319
- * WeightedAvg
320
- *
321
- * DensityIndicators
322
- *
323
- * DividedSum
324
- */
325
- aggregation?: AggregationFunction;
326
- /** Eql expression. Provides dynamic calculated value of the attribute. */
327
- expression?: string;
328
- /** Sets attribute format settings. */
329
- stringFormat?: AttributeFormatDc;
330
- /** Name of the table. */
331
- tableName?: string;
332
- /** Client data storage. Storage isn't used by server. */
333
- clientData?: any;
334
- /** Id of table given attribute is referenced. */
335
- referenceId?: string;
336
- /** A set of layer references. */
337
- layerReferenceId?: string[];
338
- /**
339
- *
340
- *
341
- * None
256
+ * Default
342
257
  *
343
- * SelectFromHandBook
258
+ * String
344
259
  *
345
- * SelectFromRange
260
+ * Geometry
346
261
  *
347
- * ViewHandBook
262
+ * Calculated
348
263
  */
349
- attributeSelectorType?: AttributeSelectorType;
350
- /** Values range. */
351
- ranges?: ValuesRange[];
352
- /** Information about an attribute icon. */
353
- icon?: AttributeIconDc;
354
- }
355
- /**
356
- * Information about an attribute.
357
- */
358
- export interface AttributeDefinitionDc {
264
+ attributeConfigurationType?: AttributeConfigurationType;
359
265
  /**
360
266
  *
361
267
  *
@@ -391,18 +297,20 @@ export interface AttributeDefinitionDc {
391
297
  *
392
298
  * GeometryCollection
393
299
  */
394
- type: AttributeType;
395
- /** Alias of the attribute. */
396
- alias?: string;
397
- /** Description of the attribute. */
398
- description?: string;
300
+ type?: AttributeType;
399
301
  /**
400
- * If false, the attribute must have non-null value.
401
- * @default false
302
+ * The name of the attribute.
303
+ * @minLength 1
402
304
  */
403
- isNullable?: boolean;
305
+ attributeName: string;
306
+ /** The name of the column in the data table that holds the attribute values. */
307
+ columnName?: string;
308
+ /** Human-friendly name for the attribute. */
309
+ alias?: string;
310
+ /** Description for the attribute. */
311
+ description?: string;
404
312
  /**
405
- * Whether the value of the attribute can be edited after the entry was created.
313
+ * If set to false, editing of the attribute value will be prohibited.
406
314
  * @default true
407
315
  */
408
316
  isEditable?: boolean;
@@ -412,31 +320,37 @@ export interface AttributeDefinitionDc {
412
320
  */
413
321
  isDisplayed?: boolean;
414
322
  /**
415
- *
416
- *
417
- * None
418
- *
419
- * Image
420
- *
421
- * PkkCode
422
- *
423
- * Attachments
323
+ * If false, the attribute must have non-null value.
324
+ * @default false
424
325
  */
425
- subType?: StringSubType;
426
- /** Ensures that the data in the attribute is unique across all rows in a table. */
427
- isUnique?: boolean;
428
- /** Sets true if attribute calculate on the fly. */
429
- isCalculated?: boolean;
430
- /** Provides attributes format definition settings. */
431
- stringFormat?: AttributeFormatDefinitionDc;
326
+ isNullable?: boolean;
432
327
  /**
433
- * Spatial reference identifier type in geometry type column.
434
- * @format int32
328
+ * Ensures that the data in the attribute is unique across all rows in a table.
329
+ * @default false
435
330
  */
436
- srId?: number;
331
+ isUnique?: boolean;
332
+ /** Client data storage. Storage isn't used by server. */
333
+ clientData?: any;
437
334
  /** Information about an attribute icon. */
438
335
  icon?: AttributeIconDc;
439
336
  }
337
+ /**
338
+ * Attribute configuration type.
339
+
340
+ Default
341
+
342
+ String
343
+
344
+ Geometry
345
+
346
+ Calculated
347
+ */
348
+ export declare enum AttributeConfigurationType {
349
+ Default = "Default",
350
+ String = "String",
351
+ Geometry = "Geometry",
352
+ Calculated = "Calculated"
353
+ }
440
354
  /**
441
355
  * Information about an attribute distinct.
442
356
  */
@@ -462,7 +376,7 @@ export interface AttributeDistinctsDc {
462
376
  /**
463
377
  * Sets attribute format settings.
464
378
  */
465
- export interface AttributeFormatDc {
379
+ export interface AttributeFormatConfigurationDc {
466
380
  /**
467
381
  * Sets number scaling factor.
468
382
  *
@@ -519,29 +433,6 @@ export interface AttributeFormatDc {
519
433
  */
520
434
  rounding?: number;
521
435
  }
522
- /**
523
- * Provides attributes format definition settings.
524
- */
525
- export interface AttributeFormatDefinitionDc {
526
- /**
527
- * Gets number scaling factor.
528
- * @format float
529
- */
530
- scalingFactor?: number;
531
- /** Gets appended value text label. */
532
- unitsLabel?: string;
533
- /** Gets template to format attribute value. */
534
- format?: string;
535
- /** Gets formatting culture. Default current. */
536
- culture?: string;
537
- /** Split digit in groups. */
538
- splitDigitGroup?: boolean;
539
- /**
540
- * Rounds digit.
541
- * @format int32
542
- */
543
- rounding?: number;
544
- }
545
436
  /**
546
437
  * Information about an attribute icon.
547
438
  */
@@ -585,23 +476,6 @@ export declare enum AttributeIconType {
585
476
  /**
586
477
  *
587
478
 
588
- None
589
-
590
- SelectFromHandBook
591
-
592
- SelectFromRange
593
-
594
- ViewHandBook
595
- */
596
- export declare enum AttributeSelectorType {
597
- None = "None",
598
- SelectFromHandBook = "SelectFromHandBook",
599
- SelectFromRange = "SelectFromRange",
600
- ViewHandBook = "ViewHandBook"
601
- }
602
- /**
603
- *
604
-
605
479
  Unknown
606
480
 
607
481
  String
@@ -656,25 +530,21 @@ export declare enum AttributeType {
656
530
  * Configuration of the attribute set in a feature layer.
657
531
  */
658
532
  export interface AttributesConfigurationDc {
533
+ /** Sets false if the layer is readonly. */
534
+ isEditable?: boolean;
659
535
  /**
660
536
  * The name of the attribute that is used for identifying features.
661
537
  * @minLength 1
662
538
  */
663
539
  idAttribute: string;
664
- /** The name of the attribute that is used for setting feature name (optional). */
665
- titleAttribute?: string;
666
540
  /** The name of the attribute that contains the feature geometry. */
667
541
  geometryAttribute?: string;
542
+ /** The name of the attribute that is used for setting feature name (optional). */
543
+ titleAttribute?: string;
668
544
  /** Name of the attribute that contains the ordering of the feature. */
669
545
  orderAttribute?: string;
670
- /** The name of the table in data source service, that contains the data for this layer. */
671
- tableName?: string;
672
546
  /** Configuration of the attributes of the layer. */
673
- attributes?: (AttributeConfigurationDc | EqlAttributeConfigurationDc)[];
674
- /** Configuration of layer references. */
675
- layerReferences?: LayerReferenceConfigurationDc[];
676
- /** Values ranges. */
677
- valuesRange?: ValuesRangeDc[];
547
+ attributes?: (AttributeConfigurationDc | CalculatedAttributeConfigurationDc | GeometryAttributeConfigurationDc | StringAttributeConfigurationDc)[];
678
548
  }
679
549
  /**
680
550
  *
@@ -763,6 +633,72 @@ export interface BulkOperationResultDc {
763
633
  /** Sets true. */
764
634
  isSuccess?: boolean;
765
635
  }
636
+ /**
637
+ * Represents the data contract for a calculated attribute configuration, including aggregation and conditional
638
+ logic settings.
639
+ */
640
+ export type CalculatedAttributeConfigurationDc = AttributeConfigurationDc & {
641
+ /**
642
+ * Attribute configuration type.
643
+ *
644
+ * Default
645
+ *
646
+ * String
647
+ *
648
+ * Geometry
649
+ *
650
+ * Calculated
651
+ */
652
+ attributeConfigurationType?: AttributeConfigurationType;
653
+ /** String condition. */
654
+ stringCondition?: string | null;
655
+ /**
656
+ *
657
+ *
658
+ * None
659
+ *
660
+ * Array
661
+ *
662
+ * Min
663
+ *
664
+ * Max
665
+ *
666
+ * Avg
667
+ *
668
+ * Sum
669
+ *
670
+ * Extent
671
+ *
672
+ * H3
673
+ *
674
+ * Count
675
+ *
676
+ * TotalCount
677
+ *
678
+ * DistinctCount
679
+ *
680
+ * First
681
+ *
682
+ * Last
683
+ *
684
+ * Median
685
+ *
686
+ * Mod
687
+ *
688
+ * StdDeviation
689
+ *
690
+ * SumOfProduct
691
+ *
692
+ * OnlyValue
693
+ *
694
+ * WeightedAvg
695
+ *
696
+ * DensityIndicators
697
+ *
698
+ * DividedSum
699
+ */
700
+ aggregation?: AggregationFunction;
701
+ };
766
702
  /**
767
703
  * Resource catalog item.
768
704
  */
@@ -1661,54 +1597,6 @@ export interface EnvelopeDc {
1661
1597
  */
1662
1598
  srId?: number;
1663
1599
  }
1664
- /**
1665
- * Configuration of an attribute in a feature layer.
1666
- */
1667
- export type EqlAttributeConfigurationDc = AttributeConfigurationDc & {
1668
- /**
1669
- *
1670
- *
1671
- * Unknown
1672
- *
1673
- * String
1674
- *
1675
- * Int32
1676
- *
1677
- * Int64
1678
- *
1679
- * Double
1680
- *
1681
- * DateTime
1682
- *
1683
- * Boolean
1684
- *
1685
- * Point
1686
- *
1687
- * LineString
1688
- *
1689
- * Polygon
1690
- *
1691
- * MultiPoint
1692
- *
1693
- * MultiLineString
1694
- *
1695
- * H3Index
1696
- *
1697
- * Json
1698
- *
1699
- * MultiPolygon
1700
- *
1701
- * GeometryCollection
1702
- */
1703
- type?: AttributeType;
1704
- };
1705
- /**
1706
- * Configuration of the attribute set in a feature layer.
1707
- */
1708
- export type EqlAttributesConfigurationDc = AttributesConfigurationDc & {
1709
- /** Configuration of the attributes of the layer. */
1710
- attributes?: EqlAttributeConfigurationDc[] | null;
1711
- };
1712
1600
  /**
1713
1601
  * CTE dependency.
1714
1602
  */
@@ -2164,6 +2052,33 @@ export interface GeocodeSuggestResultDc {
2164
2052
  /** Source id. */
2165
2053
  id?: string;
2166
2054
  }
2055
+ /**
2056
+ * Information about a string attribute.
2057
+ */
2058
+ export type GeometryAttributeConfigurationDc = AttributeConfigurationDc & {
2059
+ /**
2060
+ * Attribute configuration type.
2061
+ *
2062
+ * Default
2063
+ *
2064
+ * String
2065
+ *
2066
+ * Geometry
2067
+ *
2068
+ * Calculated
2069
+ */
2070
+ attributeConfigurationType?: AttributeConfigurationType;
2071
+ /**
2072
+ * Spatial reference identifier type in geometry type column.
2073
+ * @format int32
2074
+ */
2075
+ srId?: number | null;
2076
+ /**
2077
+ * Size of H3 index grid.
2078
+ * @format float
2079
+ */
2080
+ cellSize?: number;
2081
+ };
2167
2082
  /**
2168
2083
  * Multipoint geometry object definition.
2169
2084
  */
@@ -2531,8 +2446,8 @@ export interface ImportLayerDataSchemaDc {
2531
2446
  objectCount?: number;
2532
2447
  /** Assumed coordinate fields. */
2533
2448
  coordinateFields?: string[];
2534
- /** Information about the layer attributes and their configuration. */
2535
- layerDefinition?: LayerDefinitionDc;
2449
+ /** Configuration of the attribute set in a feature layer. */
2450
+ attributesConfiguration?: AttributesConfigurationDc;
2536
2451
  /** Schema of a inner layers. */
2537
2452
  children?: ImportLayerDataSchemaDc[];
2538
2453
  }
@@ -2558,79 +2473,6 @@ export interface IncreaseResourcesLimitDc {
2558
2473
  /** Request justification. */
2559
2474
  justification?: string;
2560
2475
  }
2561
- /**
2562
- * Information about the layer attributes and their configuration.
2563
- */
2564
- export interface LayerDefinitionDc {
2565
- /** The name of the attribute that is used to uniquely identify a feature in the layer. */
2566
- idAttribute?: string;
2567
- /** The name of the attribute that is used as a displayed name of a feature in the layer. */
2568
- titleAttribute?: string;
2569
- /** The name of the attribute that is used for assigning geometry value for the feature. */
2570
- geometryAttribute?: string;
2571
- /**
2572
- *
2573
- *
2574
- * Unknown
2575
- *
2576
- * Point
2577
- *
2578
- * LineString
2579
- *
2580
- * Polygon
2581
- *
2582
- * MultiPoint
2583
- *
2584
- * MultiLineString
2585
- *
2586
- * MultiPolygon
2587
- *
2588
- * GeometryCollection
2589
- *
2590
- * CircularString
2591
- *
2592
- * CompoundCurve
2593
- *
2594
- * CurvePolygon
2595
- *
2596
- * MultiCurve
2597
- *
2598
- * MultiSurface
2599
- *
2600
- * Curve
2601
- *
2602
- * Surface
2603
- *
2604
- * PolyhedralSurface
2605
- *
2606
- * TIN
2607
- */
2608
- geometryType?: OgcGeometryType;
2609
- /**
2610
- * The spatial reference of the layer.
2611
- * @format int32
2612
- */
2613
- srId?: number;
2614
- /** Sets false if the layer is readonly. */
2615
- isEditable?: boolean;
2616
- /** The description of the attributes of the layer. */
2617
- attributes?: Record<string, AttributeDefinitionDc>;
2618
- }
2619
- /**
2620
- * Layer reference configuration.
2621
- */
2622
- export interface LayerReferenceConfigurationDc {
2623
- /** Name of the layer. */
2624
- layerName?: string;
2625
- /** Condition to apply. */
2626
- condition?: string;
2627
- /** Attribute name in base layer. */
2628
- referenceAttribute?: string;
2629
- /** Attribute name in target layer. */
2630
- targetAttribute?: string;
2631
- /** Id of the reference. */
2632
- referenceId?: string;
2633
- }
2634
2476
  /**
2635
2477
  * Specifies the available types of layer services that can be used within the application.
2636
2478
 
@@ -2748,8 +2590,8 @@ export type LinearServiceConfigurationDc = ServiceConfigurationBaseDc & {
2748
2590
  * RouteLayerService
2749
2591
  */
2750
2592
  layerType?: LayerServiceType;
2751
- /** Configuration of the attributes of the layer. */
2752
- attributesConfiguration: AttributesConfigurationDc | EqlAttributesConfigurationDc;
2593
+ /** Configuration of the attribute set in a feature layer. */
2594
+ attributesConfiguration: AttributesConfigurationDc;
2753
2595
  /** Condition to filter returned features. */
2754
2596
  condition?: string | null;
2755
2597
  /**
@@ -3636,8 +3478,8 @@ export type PostgresTileCatalogServiceConfigurationDc = ServiceConfigurationBase
3636
3478
  * RouteLayerService
3637
3479
  */
3638
3480
  layerType?: LayerServiceType;
3639
- /** Configuration of the attributes of the layer. */
3640
- attributesConfiguration: AttributesConfigurationDc | EqlAttributesConfigurationDc;
3481
+ /** Configuration of the attribute set in a feature layer. */
3482
+ attributesConfiguration: AttributesConfigurationDc;
3641
3483
  /** Client style data storage. Storage isn't used by server. */
3642
3484
  clientStyle?: any;
3643
3485
  /** Condition to filter returned features. */
@@ -3864,8 +3706,6 @@ export type ProxyServiceConfigurationDc = ServiceConfigurationBaseDc & {
3864
3706
  * Service info for a Proxy service.
3865
3707
  */
3866
3708
  export type ProxyServiceInfoDc = ServiceInfoDc & {
3867
- /** Information about the layer attributes and their configuration. */
3868
- layerDefinition?: LayerDefinitionDc;
3869
3709
  /**
3870
3710
  * Source system type, e.g. "ArcGIS".
3871
3711
  * @minLength 1
@@ -4119,7 +3959,7 @@ export type QueryLayerServiceConfigurationDc = ServiceConfigurationBaseDc & {
4119
3959
  */
4120
3960
  geometryType?: OgcGeometryType;
4121
3961
  /** Configuration of the attribute set in a feature layer. */
4122
- attributesConfiguration?: EqlAttributesConfigurationDc;
3962
+ attributesConfiguration?: AttributesConfigurationDc;
4123
3963
  /** Client style data storage. Storage isn't used by server. */
4124
3964
  clientStyle?: any;
4125
3965
  /** Condition to filter returned features. */
@@ -4220,8 +4060,6 @@ export interface QueryLayerServiceEqlParameterQueryValueConfigurationDc {
4220
4060
  * Service info for a feature layer service.
4221
4061
  */
4222
4062
  export type QueryLayerServiceInfoDc = ServiceInfoDc & {
4223
- /** Information about the layer attributes and their configuration. */
4224
- layerDefinition: LayerDefinitionDc;
4225
4063
  /** Provides data source type. */
4226
4064
  dataSourceType?: string | null;
4227
4065
  };
@@ -4834,8 +4672,8 @@ export type RouteServiceConfigurationDc = ServiceConfigurationBaseDc & {
4834
4672
  * RouteLayerService
4835
4673
  */
4836
4674
  layerType?: LayerServiceType;
4837
- /** Configuration of the attributes of the layer. */
4838
- attributesConfiguration: AttributesConfigurationDc | EqlAttributesConfigurationDc;
4675
+ /** Configuration of the attribute set in a feature layer. */
4676
+ attributesConfiguration: AttributesConfigurationDc;
4839
4677
  /** Client style data storage. Storage isn't used by server. */
4840
4678
  clientStyle?: any;
4841
4679
  /** Condition to filter returned features. */
@@ -5008,11 +4846,6 @@ export interface ServiceConfigurationBaseDc {
5008
4846
  * The `ServiceInfoDc` provides information about the service.
5009
4847
  */
5010
4848
  export type ServiceInfoDc = BaseResourceInfoDc & {
5011
- /**
5012
- * The type of the resource.
5013
- * @minLength 1
5014
- */
5015
- type: string;
5016
4849
  /** The category of the service. */
5017
4850
  categories?: string[] | null;
5018
4851
  /**
@@ -5358,6 +5191,37 @@ export interface StatusResponseDc {
5358
5191
  */
5359
5192
  lastSyncAt?: string;
5360
5193
  }
5194
+ /**
5195
+ * Information about a string attribute.
5196
+ */
5197
+ export type StringAttributeConfigurationDc = AttributeConfigurationDc & {
5198
+ /**
5199
+ * Attribute configuration type.
5200
+ *
5201
+ * Default
5202
+ *
5203
+ * String
5204
+ *
5205
+ * Geometry
5206
+ *
5207
+ * Calculated
5208
+ */
5209
+ attributeConfigurationType?: AttributeConfigurationType;
5210
+ /**
5211
+ *
5212
+ *
5213
+ * None
5214
+ *
5215
+ * Image
5216
+ *
5217
+ * PkkCode
5218
+ *
5219
+ * Attachments
5220
+ */
5221
+ subType?: StringSubType;
5222
+ /** Sets attribute format settings. */
5223
+ stringFormat?: AttributeFormatConfigurationDc;
5224
+ };
5361
5225
  /**
5362
5226
  *
5363
5227
 
@@ -6039,8 +5903,6 @@ export interface TestConnectionInfoDc {
6039
5903
  * Service info for a tile catalog layer service.
6040
5904
  */
6041
5905
  export type TileCatalogServiceInfoDc = ServiceInfoDc & {
6042
- /** Information about the layer attributes and their configuration. */
6043
- layerDefinition: LayerDefinitionDc;
6044
5906
  /** Tile info structure. */
6045
5907
  tileInfo: TileInfoDc;
6046
5908
  };
@@ -6352,19 +6214,6 @@ export interface ValueDc {
6352
6214
  /** Value. */
6353
6215
  value?: any;
6354
6216
  }
6355
- export interface ValuesRange {
6356
- min?: any;
6357
- max?: any;
6358
- }
6359
- /**
6360
- * Values range.
6361
- */
6362
- export interface ValuesRangeDc {
6363
- /** Minimum value. */
6364
- min: any;
6365
- /** Maximum value. */
6366
- max: any;
6367
- }
6368
6217
  export interface VersionDto {
6369
6218
  /** @format int32 */
6370
6219
  versionNumber?: number;