@osdk/internal.foundry.ontologies 2.52.0 → 2.54.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @osdk/internal.foundry.ontologies
 
+## 2.54.0
+
+### Minor Changes
+
+- d1a0cd3: Regenerating platform sdks.
+
+### Patch Changes
+
+- Updated dependencies [d1a0cd3]
+  - @osdk/internal.foundry.core@2.54.0
+  - @osdk/internal.foundry.geo@2.54.0
+
+## 2.53.0
+
+### Minor Changes
+
+- 085010e: Regenerate Platform SDKs
+
+### Patch Changes
+
+- Updated dependencies [085010e]
+  - @osdk/internal.foundry.core@2.53.0
+  - @osdk/internal.foundry.geo@2.53.0
+
 ## 2.52.0
 
 ### Minor Changes

package/build/browser/_components.d.ts

@@ -360,11 +360,13 @@ export interface AggregationDurationGrouping {
 /**
    * Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.
 When grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1.
+Either field or propertyIdentifier must be supplied, but not both.
    *
    * Log Safety: UNSAFE
    */
 export interface AggregationDurationGroupingV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     value: number;
     unit: TimeUnit;
 }
@@ -378,12 +380,14 @@ export interface AggregationExactGrouping {
     maxGroupCount?: number;
 }
 /**
- * Divides objects into groups according to an exact value.
- *
- * Log Safety: UNSAFE
- */
+   * Divides objects into groups according to an exact value.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface AggregationExactGroupingV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     maxGroupCount?: number;
     defaultValue?: string;
     includeNullValues?: boolean;
@@ -398,12 +402,14 @@ export interface AggregationFixedWidthGrouping {
     fixedWidth: number;
 }
 /**
- * Divides objects into groups with the specified width.
- *
- * Log Safety: UNSAFE
- */
+   * Divides objects into groups with the specified width.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface AggregationFixedWidthGroupingV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     fixedWidth: number;
 }
 /**
@@ -505,12 +511,14 @@ export interface AggregationRangesGrouping {
     ranges: Array<AggregationRange>;
 }
 /**
- * Divides objects into groups according to specified ranges.
- *
- * Log Safety: UNSAFE
- */
+   * Divides objects into groups according to specified ranges.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface AggregationRangesGroupingV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     ranges: Array<AggregationRangeV2>;
 }
 /**
@@ -669,22 +677,26 @@ export interface ApproximateDistinctAggregation {
     name?: AggregationMetricName;
 }
 /**
- * Computes an approximate number of distinct values for the provided field.
- *
- * Log Safety: UNSAFE
- */
+   * Computes an approximate number of distinct values for the provided field.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface ApproximateDistinctAggregationV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     name?: AggregationMetricName;
     direction?: OrderByDirection;
 }
 /**
- * Computes the approximate percentile value for the provided field. Requires Object Storage V2.
- *
- * Log Safety: UNSAFE
- */
+   * Computes the approximate percentile value for the provided field. Requires Object Storage V2.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface ApproximatePercentileAggregationV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     name?: AggregationMetricName;
     approximatePercentile: number;
     direction?: OrderByDirection;
@@ -836,12 +848,14 @@ export interface AvgAggregation {
     name?: AggregationMetricName;
 }
 /**
- * Computes the average value for the provided field.
- *
- * Log Safety: UNSAFE
- */
+   * Computes the average value for the provided field.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface AvgAggregationV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     name?: AggregationMetricName;
     direction?: OrderByDirection;
 }
@@ -1608,12 +1622,15 @@ export interface ErrorComputingSecurity {
  */
 export type ErrorName = LooselyBrandedString<"ErrorName">;
 /**
- * Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.
- *
- * Log Safety: UNSAFE
- */
+   * Computes an exact number of distinct values for the provided field. May be slower than an approximate
+distinct aggregation. Requires Object Storage V2.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface ExactDistinctAggregationV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     name?: AggregationMetricName;
     direction?: OrderByDirection;
 }
@@ -1825,6 +1842,24 @@ export interface GetActionTypeByRidBatchRequestElement {
 export interface GetActionTypeByRidBatchResponse {
     data: Array<ActionTypeV2>;
 }
+/**
+ * Log Safety: SAFE
+ */
+export interface GetObjectTypeByRidBatchRequest {
+    requests: Array<GetObjectTypeByRidBatchRequestElement>;
+}
+/**
+ * Log Safety: SAFE
+ */
+export interface GetObjectTypeByRidBatchRequestElement {
+    objectTypeRid: ObjectTypeRid;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface GetObjectTypeByRidBatchResponse {
+    data: Array<ObjectTypeV2>;
+}
 /**
    * Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could
 explode the cardinality.
@@ -2737,12 +2772,14 @@ export interface MaxAggregation {
     name?: AggregationMetricName;
 }
 /**
- * Computes the maximum value for the provided field.
- *
- * Log Safety: UNSAFE
- */
+   * Computes the maximum value for the provided field.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface MaxAggregationV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     name?: AggregationMetricName;
     direction?: OrderByDirection;
 }
@@ -2772,12 +2809,14 @@ export interface MinAggregation {
     name?: AggregationMetricName;
 }
 /**
- * Computes the minimum value for the provided field.
- *
- * Log Safety: UNSAFE
- */
+   * Computes the minimum value for the provided field.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface MinAggregationV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     name?: AggregationMetricName;
     direction?: OrderByDirection;
 }
@@ -4458,48 +4497,50 @@ export type QueryDataType = ({
 } & OntologyInterfaceObjectType) | ({
     type: "struct";
 } & QueryStructType) | ({
-    type: "set";
-} & QuerySetType) | ({
-    type: "void";
-} & _Core.VoidType) | ({
     type: "string";
 } & _Core.StringType) | ({
-    type: "entrySet";
-} & EntrySetType) | ({
-    type: "double";
-} & _Core.DoubleType) | ({
     type: "integer";
 } & _Core.IntegerType) | ({
     type: "threeDimensionalAggregation";
 } & ThreeDimensionalAggregation) | ({
-    type: "union";
-} & QueryUnionType) | ({
     type: "float";
 } & _Core.FloatType) | ({
     type: "long";
 } & _Core.LongType) | ({
-    type: "boolean";
-} & _Core.BooleanType) | ({
     type: "unsupported";
 } & _Core.UnsupportedType) | ({
     type: "attachment";
 } & _Core.AttachmentType) | ({
-    type: "mediaReference";
-} & _Core.MediaReferenceType) | ({
-    type: "null";
-} & _Core.NullType) | ({
     type: "array";
 } & QueryArrayType) | ({
     type: "objectSet";
 } & OntologyObjectSetType) | ({
     type: "twoDimensionalAggregation";
 } & TwoDimensionalAggregation) | ({
+    type: "typeReference";
+} & QueryTypeReferenceType) | ({
+    type: "timestamp";
+} & _Core.TimestampType) | ({
+    type: "set";
+} & QuerySetType) | ({
+    type: "void";
+} & _Core.VoidType) | ({
+    type: "entrySet";
+} & EntrySetType) | ({
+    type: "double";
+} & _Core.DoubleType) | ({
+    type: "union";
+} & QueryUnionType) | ({
+    type: "boolean";
+} & _Core.BooleanType) | ({
+    type: "mediaReference";
+} & _Core.MediaReferenceType) | ({
+    type: "null";
+} & _Core.NullType) | ({
     type: "interfaceObjectSet";
 } & OntologyInterfaceObjectSetType) | ({
     type: "object";
-} & OntologyObjectType) | ({
-    type: "timestamp";
-} & _Core.TimestampType);
+} & OntologyObjectType);
 /**
  * Details about the output of a query.
  *
@@ -4567,6 +4608,15 @@ export interface QueryType {
     rid: FunctionRid;
     version: FunctionVersion;
 }
+/**
+   * A reference to a type that is defined in the typeReferences map of the enclosing Query.
+This enables support for recursive type definitions where a type may reference itself.
+   *
+   * Log Safety: SAFE
+   */
+export interface QueryTypeReferenceType {
+    typeId: TypeReferenceIdentifier;
+}
 /**
  * Represents a query type in the Ontology.
  *
@@ -4580,6 +4630,7 @@ export interface QueryTypeV2 {
     output: QueryDataType;
     rid: FunctionRid;
     version: FunctionVersion;
+    typeReferences: Record<TypeReferenceIdentifier, QueryDataType>;
 }
 /**
  * Log Safety: UNSAFE
@@ -5500,12 +5551,14 @@ export interface SumAggregation {
     name?: AggregationMetricName;
 }
 /**
- * Computes the sum of values for the provided field.
- *
- * Log Safety: UNSAFE
- */
+   * Computes the sum of values for the provided field.
+Either field or propertyIdentifier must be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface SumAggregationV2 {
-    field: PropertyApiName;
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
     name?: AggregationMetricName;
     direction?: OrderByDirection;
 }
@@ -5701,6 +5754,13 @@ export interface TypeClass {
     kind: string;
     name: string;
 }
+/**
+   * The unique identifier of a type reference. This identifier is used to look up the
+type definition in the typeReferences map of the enclosing Query.
+   *
+   * Log Safety: SAFE
+   */
+export type TypeReferenceIdentifier = LooselyBrandedString<"TypeReferenceIdentifier">;
 /**
    * The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.
 This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.