@osdk/foundry.ontologies 2.52.0 → 2.53.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @osdk/foundry.ontologies
2
2
 
3
+ ## 2.53.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 085010e: Regenerate Platform SDKs
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [085010e]
12
+ - @osdk/foundry.core@2.53.0
13
+ - @osdk/foundry.geo@2.53.0
14
+
3
15
  ## 2.52.0
4
16
 
5
17
  ### Minor Changes
@@ -360,11 +360,13 @@ export interface AggregationDurationGrouping {
360
360
  /**
361
361
  * Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.
362
362
  When grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1.
363
+ Either field or propertyIdentifier must be supplied, but not both.
363
364
  *
364
365
  * Log Safety: UNSAFE
365
366
  */
366
367
  export interface AggregationDurationGroupingV2 {
367
- field: PropertyApiName;
368
+ field?: PropertyApiName;
369
+ propertyIdentifier?: PropertyIdentifier;
368
370
  value: number;
369
371
  unit: TimeUnit;
370
372
  }
@@ -378,12 +380,14 @@ export interface AggregationExactGrouping {
378
380
  maxGroupCount?: number;
379
381
  }
380
382
  /**
381
- * Divides objects into groups according to an exact value.
382
- *
383
- * Log Safety: UNSAFE
384
- */
383
+ * Divides objects into groups according to an exact value.
384
+ Either field or propertyIdentifier must be supplied, but not both.
385
+ *
386
+ * Log Safety: UNSAFE
387
+ */
385
388
  export interface AggregationExactGroupingV2 {
386
- field: PropertyApiName;
389
+ field?: PropertyApiName;
390
+ propertyIdentifier?: PropertyIdentifier;
387
391
  maxGroupCount?: number;
388
392
  defaultValue?: string;
389
393
  includeNullValues?: boolean;
@@ -398,12 +402,14 @@ export interface AggregationFixedWidthGrouping {
398
402
  fixedWidth: number;
399
403
  }
400
404
  /**
401
- * Divides objects into groups with the specified width.
402
- *
403
- * Log Safety: UNSAFE
404
- */
405
+ * Divides objects into groups with the specified width.
406
+ Either field or propertyIdentifier must be supplied, but not both.
407
+ *
408
+ * Log Safety: UNSAFE
409
+ */
405
410
  export interface AggregationFixedWidthGroupingV2 {
406
- field: PropertyApiName;
411
+ field?: PropertyApiName;
412
+ propertyIdentifier?: PropertyIdentifier;
407
413
  fixedWidth: number;
408
414
  }
409
415
  /**
@@ -505,12 +511,14 @@ export interface AggregationRangesGrouping {
505
511
  ranges: Array<AggregationRange>;
506
512
  }
507
513
  /**
508
- * Divides objects into groups according to specified ranges.
509
- *
510
- * Log Safety: UNSAFE
511
- */
514
+ * Divides objects into groups according to specified ranges.
515
+ Either field or propertyIdentifier must be supplied, but not both.
516
+ *
517
+ * Log Safety: UNSAFE
518
+ */
512
519
  export interface AggregationRangesGroupingV2 {
513
- field: PropertyApiName;
520
+ field?: PropertyApiName;
521
+ propertyIdentifier?: PropertyIdentifier;
514
522
  ranges: Array<AggregationRangeV2>;
515
523
  }
516
524
  /**
@@ -669,22 +677,26 @@ export interface ApproximateDistinctAggregation {
669
677
  name?: AggregationMetricName;
670
678
  }
671
679
  /**
672
- * Computes an approximate number of distinct values for the provided field.
673
- *
674
- * Log Safety: UNSAFE
675
- */
680
+ * Computes an approximate number of distinct values for the provided field.
681
+ Either field or propertyIdentifier must be supplied, but not both.
682
+ *
683
+ * Log Safety: UNSAFE
684
+ */
676
685
  export interface ApproximateDistinctAggregationV2 {
677
- field: PropertyApiName;
686
+ field?: PropertyApiName;
687
+ propertyIdentifier?: PropertyIdentifier;
678
688
  name?: AggregationMetricName;
679
689
  direction?: OrderByDirection;
680
690
  }
681
691
  /**
682
- * Computes the approximate percentile value for the provided field. Requires Object Storage V2.
683
- *
684
- * Log Safety: UNSAFE
685
- */
692
+ * Computes the approximate percentile value for the provided field. Requires Object Storage V2.
693
+ Either field or propertyIdentifier must be supplied, but not both.
694
+ *
695
+ * Log Safety: UNSAFE
696
+ */
686
697
  export interface ApproximatePercentileAggregationV2 {
687
- field: PropertyApiName;
698
+ field?: PropertyApiName;
699
+ propertyIdentifier?: PropertyIdentifier;
688
700
  name?: AggregationMetricName;
689
701
  approximatePercentile: number;
690
702
  direction?: OrderByDirection;
@@ -836,12 +848,14 @@ export interface AvgAggregation {
836
848
  name?: AggregationMetricName;
837
849
  }
838
850
  /**
839
- * Computes the average value for the provided field.
840
- *
841
- * Log Safety: UNSAFE
842
- */
851
+ * Computes the average value for the provided field.
852
+ Either field or propertyIdentifier must be supplied, but not both.
853
+ *
854
+ * Log Safety: UNSAFE
855
+ */
843
856
  export interface AvgAggregationV2 {
844
- field: PropertyApiName;
857
+ field?: PropertyApiName;
858
+ propertyIdentifier?: PropertyIdentifier;
845
859
  name?: AggregationMetricName;
846
860
  direction?: OrderByDirection;
847
861
  }
@@ -1608,12 +1622,15 @@ export interface ErrorComputingSecurity {
1608
1622
  */
1609
1623
  export type ErrorName = LooselyBrandedString<"ErrorName">;
1610
1624
  /**
1611
- * Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.
1612
- *
1613
- * Log Safety: UNSAFE
1614
- */
1625
+ * Computes an exact number of distinct values for the provided field. May be slower than an approximate
1626
+ distinct aggregation. Requires Object Storage V2.
1627
+ Either field or propertyIdentifier must be supplied, but not both.
1628
+ *
1629
+ * Log Safety: UNSAFE
1630
+ */
1615
1631
  export interface ExactDistinctAggregationV2 {
1616
- field: PropertyApiName;
1632
+ field?: PropertyApiName;
1633
+ propertyIdentifier?: PropertyIdentifier;
1617
1634
  name?: AggregationMetricName;
1618
1635
  direction?: OrderByDirection;
1619
1636
  }
@@ -2737,12 +2754,14 @@ export interface MaxAggregation {
2737
2754
  name?: AggregationMetricName;
2738
2755
  }
2739
2756
  /**
2740
- * Computes the maximum value for the provided field.
2741
- *
2742
- * Log Safety: UNSAFE
2743
- */
2757
+ * Computes the maximum value for the provided field.
2758
+ Either field or propertyIdentifier must be supplied, but not both.
2759
+ *
2760
+ * Log Safety: UNSAFE
2761
+ */
2744
2762
  export interface MaxAggregationV2 {
2745
- field: PropertyApiName;
2763
+ field?: PropertyApiName;
2764
+ propertyIdentifier?: PropertyIdentifier;
2746
2765
  name?: AggregationMetricName;
2747
2766
  direction?: OrderByDirection;
2748
2767
  }
@@ -2772,12 +2791,14 @@ export interface MinAggregation {
2772
2791
  name?: AggregationMetricName;
2773
2792
  }
2774
2793
  /**
2775
- * Computes the minimum value for the provided field.
2776
- *
2777
- * Log Safety: UNSAFE
2778
- */
2794
+ * Computes the minimum value for the provided field.
2795
+ Either field or propertyIdentifier must be supplied, but not both.
2796
+ *
2797
+ * Log Safety: UNSAFE
2798
+ */
2779
2799
  export interface MinAggregationV2 {
2780
- field: PropertyApiName;
2800
+ field?: PropertyApiName;
2801
+ propertyIdentifier?: PropertyIdentifier;
2781
2802
  name?: AggregationMetricName;
2782
2803
  direction?: OrderByDirection;
2783
2804
  }
@@ -5502,12 +5523,14 @@ export interface SumAggregation {
5502
5523
  name?: AggregationMetricName;
5503
5524
  }
5504
5525
  /**
5505
- * Computes the sum of values for the provided field.
5506
- *
5507
- * Log Safety: UNSAFE
5508
- */
5526
+ * Computes the sum of values for the provided field.
5527
+ Either field or propertyIdentifier must be supplied, but not both.
5528
+ *
5529
+ * Log Safety: UNSAFE
5530
+ */
5509
5531
  export interface SumAggregationV2 {
5510
- field: PropertyApiName;
5532
+ field?: PropertyApiName;
5533
+ propertyIdentifier?: PropertyIdentifier;
5511
5534
  name?: AggregationMetricName;
5512
5535
  direction?: OrderByDirection;
5513
5536
  }