@osdk/internal.foundry.ontologies 2.47.0 → 2.49.0

package/build/esm/_components.d.ts

@@ -231,7 +231,7 @@ export interface AddObject {
  */
 export interface AddObjectEdit {
     objectType: ObjectTypeApiName;
-    properties: Record<PropertyApiName, DataValue>;
+    properties: Record<PropertyApiName, DataValue | undefined>;
 }
 /**
  * Adds two or more numeric values.
@@ -1520,17 +1520,28 @@ export type EditHistoryEdit = ({
 /**
  * Log Safety: UNSAFE
  */
-export interface EditsHistoryFilters {
-    startTime?: string;
-    endTime?: string;
-    actionTypes: Array<ActionTypeApiName>;
-    editTypes: Array<EditTypeFilter>;
-    userIds: Array<string>;
+export type EditsHistoryFilter = ({
+    type: "timestampFilter";
+} & EditsHistoryTimestampFilter) | ({
+    type: "operationIdsFilter";
+} & EditsHistoryOperationIdsFilter);
+/**
+ * Log Safety: SAFE
+ */
+export interface EditsHistoryOperationIdsFilter {
+    operationIds: Array<ActionRid>;
 }
 /**
  * Log Safety: SAFE
  */
 export type EditsHistorySortOrder = "newest_first" | "oldest_first";
+/**
+ * Log Safety: SAFE
+ */
+export interface EditsHistoryTimestampFilter {
+    startTime?: string;
+    endTime?: string;
+}
 /**
  * Log Safety: SAFE
  */
@@ -1549,10 +1560,11 @@ export interface EnumConstraint {
     options: Array<PropertyValue | undefined>;
 }
 /**
- * Returns objects where the specified field is equal to a value.
- *
- * Log Safety: UNSAFE
- */
+   * Returns objects where the specified field is equal to a value.
+For string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.
+   *
+   * Log Safety: UNSAFE
+   */
 export interface EqualsQuery {
     field: FieldNameV1;
     value: PropertyValue;
@@ -1560,6 +1572,7 @@ export interface EqualsQuery {
 /**
    * Returns objects where the specified field is equal to a value. Allows you to specify a property to query on
 by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
+For string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.
    *
    * Log Safety: UNSAFE
    */
@@ -1695,12 +1708,54 @@ export type FunctionVersion = LooselyBrandedString<"FunctionVersion">;
  * Log Safety: SAFE
  */
 export type Fuzzy = boolean;
+/**
+   * Matches intervals containing terms that are similar to the provided term, within an edit distance
+defined by fuzziness. An edit is a single character change needed to make a term match, including
+character insertion, deletion, substitution, or transposition of two adjacent characters.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface FuzzyRule {
+    term: string;
+    fuzziness?: number;
+}
 /**
  * Setting fuzzy to true allows approximate matching in search queries that support it.
  *
  * Log Safety: SAFE
  */
 export type FuzzyV2 = boolean;
+/**
+ * A GeoJSON geometry specification.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface GeoJsonString {
+    geoJson: string;
+}
+/**
+ * Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.
+ *
+ * Log Safety: UNSAFE
+ */
+export type GeoShapeV2Geometry = ({
+    type: "envelope";
+} & BoundingBoxValue) | ({
+    type: "geoJson";
+} & GeoJsonString);
+/**
+   * Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.
+Supports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.
+Either field or propertyIdentifier can be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface GeoShapeV2Query {
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
+    geometry: GeoShapeV2Geometry;
+    spatialFilterMode: SpatialFilterMode;
+}
 /**
  * A single geotemporal data point representing the location of an entity at a specific point in time.
  *
@@ -1744,6 +1799,24 @@ export interface GeotimeSeriesValue {
     position: _Geo.Position;
     timestamp: string;
 }
+/**
+ * Log Safety: SAFE
+ */
+export interface GetActionTypeByRidBatchRequest {
+    requests: Array<GetActionTypeByRidBatchRequestElement>;
+}
+/**
+ * Log Safety: SAFE
+ */
+export interface GetActionTypeByRidBatchRequestElement {
+    actionTypeRid: ActionTypeRid;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface GetActionTypeByRidBatchResponse {
+    data: Array<ActionTypeV2>;
+}
 /**
    * 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.
@@ -1829,6 +1902,7 @@ export type Icon = {
    * Returns objects where the specified field equals any of the provided values. Allows you to
 specify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects
 in the object set. Either field or propertyIdentifier must be supplied, but not both.
+For string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.
    *
    * Log Safety: UNSAFE
    */
@@ -2112,7 +2186,9 @@ export type IntervalQueryRule = ({
     type: "anyOf";
 } & AnyOfRule) | ({
     type: "prefixOnLastToken";
-} & PrefixOnLastTokenRule);
+} & PrefixOnLastTokenRule) | ({
+    type: "fuzzy";
+} & FuzzyRule);
 /**
  * Returns objects based on the existence of the specified field.
  *
@@ -2525,6 +2601,7 @@ export interface LoadObjectSetV2ObjectsOrInterfacesResponse {
     data: Array<OntologyObjectV2>;
     nextPageToken?: _Core.PageToken;
     totalCount: _Core.TotalCount;
+    transactionId?: OntologyTransactionId;
 }
 /**
  * The Ontology metadata (i.e., object, link, action, query, and interface types) to load.
@@ -2731,7 +2808,7 @@ export interface ModifyObject {
 export interface ModifyObjectEdit {
     objectType: ObjectTypeApiName;
     primaryKey: PropertyValue;
-    properties: Record<PropertyApiName, DataValue>;
+    properties: Record<PropertyApiName, DataValue | undefined>;
 }
 /**
  * Log Safety: UNSAFE
@@ -3021,6 +3098,7 @@ created, modified, or deleted as part of an action execution.
    * Log Safety: UNSAFE
    */
 export interface ObjectEditHistoryEntry {
+    objectPrimaryKey: ObjectPrimaryKeyV2;
     operationId: ActionRid;
     actionTypeRid: ActionTypeRid;
     userId: string;
@@ -3404,7 +3482,7 @@ Otherwise, the method will return edits history for all objects of this object t
    */
 export interface ObjectTypeEditsHistoryRequest {
     objectPrimaryKey?: ObjectPrimaryKeyV2;
-    filters?: EditsHistoryFilters;
+    filters?: EditsHistoryFilter;
     sortOrder?: EditsHistorySortOrder;
     includeAllPreviousProperties?: boolean;
     pageSize?: number;
@@ -3542,6 +3620,8 @@ export type OntologyDataType = ({
 } & _Core.MarkingType) | ({
     type: "unsupported";
 } & _Core.UnsupportedType) | ({
+    type: "mediaReference";
+} & _Core.MediaReferenceType) | ({
     type: "array";
 } & OntologyArrayType) | ({
     type: "objectSet";
@@ -4394,6 +4474,8 @@ export type QueryDataType = ({
 } & _Core.UnsupportedType) | ({
     type: "attachment";
 } & _Core.AttachmentType) | ({
+    type: "mediaReference";
+} & _Core.MediaReferenceType) | ({
     type: "null";
 } & _Core.NullType) | ({
     type: "array";
@@ -4784,6 +4866,8 @@ export type SearchJsonQueryV2 = ({
 } & ContainsAnyTermQuery) | ({
     type: "interval";
 } & IntervalQuery) | ({
+    type: "geoShapeV2";
+} & GeoShapeV2Query) | ({
     type: "startsWith";
 } & StartsWithQuery);
 /**
@@ -5066,6 +5150,14 @@ export type SharedPropertyTypeApiName = LooselyBrandedString<"SharedPropertyType
  * Log Safety: SAFE
  */
 export type SharedPropertyTypeRid = LooselyBrandedString<"SharedPropertyTypeRid">;
+/**
+   * The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided
+geometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that
+lie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.
+   *
+   * Log Safety: SAFE
+   */
+export type SpatialFilterMode = "INTERSECTS" | "DISJOINT" | "WITHIN" | "CONTAINS";
 /**
    * Deprecated alias for containsAllTermsInOrderPrefixLastTerm, which is preferred because the name startsWith is misleading.
 Returns objects where the specified field starts with the provided value. Allows you to specify a property to