@osdk/foundry.ontologies 2.46.0 → 2.48.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @osdk/foundry.ontologies
 
+## 2.48.0
+
+### Minor Changes
+
+- 21e4edc: Regenerate Platform SDKs
+
+### Patch Changes
+
+- Updated dependencies [21e4edc]
+  - @osdk/foundry.core@2.48.0
+  - @osdk/foundry.geo@2.48.0
+
+## 2.47.0
+
+### Minor Changes
+
+- 0a561e6: Fix cyclic dependency
+
+### Patch Changes
+
+- Updated dependencies [0a561e6]
+  - @osdk/foundry.core@2.47.0
+  - @osdk/foundry.geo@2.47.0
+
 ## 2.46.0
 
 ### Minor Changes

package/build/browser/_components.d.ts

@@ -126,6 +126,7 @@ export interface ActionParameterV2 {
     description?: string;
     dataType: ActionParameterType;
     required: boolean;
+    typeClasses: Array<TypeClass>;
 }
 /**
  * Log Safety: UNSAFE
@@ -230,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.
@@ -921,6 +922,12 @@ export interface BlueprintIcon {
     color: string;
     name: string;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface BooleanValue {
+    value: boolean;
+}
 /**
  * The top left and bottom right coordinate points that make up the bounding box.
  *
@@ -1073,6 +1080,12 @@ export interface CountAggregationV2 {
 export interface CountObjectsResponseV2 {
     count?: number;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateEdit {
+    properties: Record<PropertyApiName, PropertyValue>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1260,6 +1273,12 @@ export interface DatetimeTimezoneStatic {
  */
 export interface DatetimeTimezoneUser {
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface DateValue {
+    value: string;
+}
 /**
  * The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.
  *
@@ -1268,6 +1287,12 @@ export interface DatetimeTimezoneUser {
 export interface DecryptionResult {
     plaintext?: Plaintext;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface DeleteEdit {
+    previousProperties: Record<PropertyApiName, PropertyValue>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1441,6 +1466,12 @@ export interface DoesNotIntersectPolygonQuery {
     propertyIdentifier?: PropertyIdentifier;
     value: PolygonValue;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface DoubleValue {
+    value: number;
+}
 /**
    * The vector to search with. The vector must be of the same dimension as the vectors stored in the provided
 propertyIdentifier.
@@ -1476,6 +1507,34 @@ export type DurationFormatStyle = ({
  * Log Safety: SAFE
  */
 export type DurationPrecision = "DAYS" | "HOURS" | "MINUTES" | "SECONDS" | "AUTO";
+/**
+ * Log Safety: UNSAFE
+ */
+export type EditHistoryEdit = ({
+    type: "createEdit";
+} & CreateEdit) | ({
+    type: "deleteEdit";
+} & DeleteEdit) | ({
+    type: "modifyEdit";
+} & ModifyEdit);
+/**
+ * Log Safety: UNSAFE
+ */
+export interface EditsHistoryFilters {
+    startTime?: string;
+    endTime?: string;
+    actionTypes: Array<ActionTypeApiName>;
+    editTypes: Array<EditTypeFilter>;
+    userIds: Array<string>;
+}
+/**
+ * Log Safety: SAFE
+ */
+export type EditsHistorySortOrder = "newest_first" | "oldest_first";
+/**
+ * Log Safety: SAFE
+ */
+export type EditTypeFilter = "create" | "modify" | "delete";
 /**
  * Log Safety: UNSAFE
  */
@@ -1490,10 +1549,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;
@@ -1501,6 +1561,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
    */
@@ -1770,6 +1831,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
    */
@@ -1778,6 +1840,12 @@ export interface InQuery {
     propertyIdentifier?: PropertyIdentifier;
     value: Array<PropertyValue>;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface IntegerValue {
+    value: number;
+}
 /**
    * An interface property type with an additional field to indicate constraints that need to be satisfied by
 implementing object property types.
@@ -1792,6 +1860,7 @@ export interface InterfaceDefinedPropertyType {
     dataType: ObjectPropertyType;
     valueTypeApiName?: ValueTypeApiName;
     requireImplementation: boolean;
+    typeClasses: Array<TypeClass>;
 }
 /**
    * A link type constraint defined at the interface level where the implementation of the links is provided
@@ -1941,6 +2010,7 @@ export interface InterfaceSharedPropertyType {
     valueTypeApiName?: ValueTypeApiName;
     valueFormatting?: PropertyValueFormattingRule;
     required: boolean;
+    typeClasses: Array<TypeClass>;
 }
 /**
  * Represents an implementation of an interface (the mapping of interface property to local property).
@@ -2513,6 +2583,12 @@ export type LogicRuleArgument = ({
 } & ObjectParameterPropertyArgument) | ({
     type: "uniqueIdentifier";
 } & UniqueIdentifierArgument);
+/**
+ * Log Safety: UNSAFE
+ */
+export interface LongValue {
+    value: string;
+}
 /**
  * Returns objects where the specified field is less than or equal to a value.
  *
@@ -2623,6 +2699,14 @@ export interface MinAggregationV2 {
     name?: AggregationMetricName;
     direction?: OrderByDirection;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ModifyEdit {
+    includesAllPreviousValues?: boolean;
+    previousProperties: Record<PropertyApiName, PropertyValue>;
+    properties: Record<PropertyApiName, PropertyValue>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2650,7 +2734,7 @@ export interface ModifyObject {
 export interface ModifyObjectEdit {
     objectType: ObjectTypeApiName;
     primaryKey: PropertyValue;
-    properties: Record<PropertyApiName, DataValue>;
+    properties: Record<PropertyApiName, DataValue | undefined>;
 }
 /**
  * Log Safety: UNSAFE
@@ -2933,6 +3017,19 @@ export type ObjectEdit = ({
 } & DeleteLink) | ({
     type: "addLink";
 } & AddLink);
+/**
+   * Represents a single object edit operation in the history. This captures when an object was
+created, modified, or deleted as part of an action execution.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface ObjectEditHistoryEntry {
+    operationId: ActionRid;
+    actionTypeRid: ActionTypeRid;
+    userId: string;
+    timestamp: string;
+    edit: EditHistoryEdit;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2974,6 +3071,10 @@ export interface ObjectParameterPropertyArgument {
  * Log Safety: UNSAFE
  */
 export type ObjectPrimaryKey = Record<PropertyApiName, PropertyValue>;
+/**
+ * Log Safety: UNSAFE
+ */
+export type ObjectPrimaryKeyV2 = Record<PropertyApiName, PrimaryKeyValueV2>;
 /**
  * A union of all the types supported by Ontology Object properties.
  *
@@ -3297,6 +3398,32 @@ export type ObjectTypeApiName = LooselyBrandedString<"ObjectTypeApiName">;
 export interface ObjectTypeEdits {
     editedObjectTypes: Array<ObjectTypeApiName>;
 }
+/**
+   * Request object for querying object type edits history, containing both filters and pagination parameters
+If objectPrimaryKey property is set, the method will return edits history for the particular object.
+Otherwise, the method will return edits history for all objects of this object type.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface ObjectTypeEditsHistoryRequest {
+    objectPrimaryKey?: ObjectPrimaryKeyV2;
+    filters?: EditsHistoryFilters;
+    sortOrder?: EditsHistorySortOrder;
+    includeAllPreviousProperties?: boolean;
+    pageSize?: number;
+    pageToken?: string;
+}
+/**
+   * Response containing the history of edits for objects of a specific object type.
+Only contains object edits (create, modify, delete) - link edits are not included.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface ObjectTypeEditsHistoryResponse {
+    data: Array<ObjectEditHistoryEntry>;
+    totalCount?: number;
+    nextPageToken?: string;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -3600,6 +3727,10 @@ export interface OntologyValueType {
     version: string;
     constraints: Array<ValueTypeConstraint>;
 }
+/**
+ * Log Safety: SAFE
+ */
+export type OntologyVersion = string;
 /**
    * A command representing the list of properties to order by. Properties should be delimited by commas and
 prefixed by p or properties. The format expected format is
@@ -3792,6 +3923,24 @@ export interface PrefixQuery {
  * Log Safety: UNSAFE
  */
 export type PrimaryKeyValue = any;
+/**
+ * Log Safety: UNSAFE
+ */
+export type PrimaryKeyValueV2 = ({
+    type: "dateValue";
+} & DateValue) | ({
+    type: "stringValue";
+} & StringValue) | ({
+    type: "timestampValue";
+} & TimestampValue) | ({
+    type: "booleanValue";
+} & BooleanValue) | ({
+    type: "integerValue";
+} & IntegerValue) | ({
+    type: "doubleValue";
+} & DoubleValue) | ({
+    type: "longValue";
+} & LongValue);
 /**
  * Details about some property of an object.
  *
@@ -4007,6 +4156,8 @@ export type PropertyTypeReferenceOrStringConstant = ({
     type: "propertyType";
 } & PropertyTypeReference);
 /**
+ * The unique resource identifier of a property.
+ *
  * Log Safety: SAFE
  */
 export type PropertyTypeRid = LooselyBrandedString<"PropertyTypeRid">;
@@ -4042,6 +4193,7 @@ export interface PropertyV2 {
     visibility?: PropertyTypeVisibility;
     valueTypeApiName?: ValueTypeApiName;
     valueFormatting?: PropertyValueFormattingRule;
+    typeClasses: Array<TypeClass>;
 }
 /**
    * Represents the value of a property in the following format.
@@ -4904,6 +5056,7 @@ export interface SharedPropertyType {
     dataType: ObjectPropertyType;
     valueTypeApiName?: ValueTypeApiName;
     valueFormatting?: PropertyValueFormattingRule;
+    typeClasses: Array<TypeClass>;
 }
 /**
    * The name of the shared property type in the API in lowerCamelCase format. To find the API name for your
@@ -4938,6 +5091,18 @@ export interface StartsWithQuery {
 export interface StaticArgument {
     value: DataValue;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface StreamGeotemporalSeriesValuesRequest {
+    range?: TimeRange;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface StreamGeotemporalSeriesValuesResponse {
+    data: Array<GeotemporalSeriesEntry>;
+}
 /**
    * Which format to serialize the binary stream in.
 ARROW is more efficient for streaming a large sized response.
@@ -5009,6 +5174,12 @@ export interface StringRegexMatchConstraint {
     regex: string;
     configuredFailureMessage?: string;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface StringValue {
+    value: string;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -5101,6 +5272,7 @@ export interface StructFieldType {
     apiName: StructFieldApiName;
     rid: StructFieldTypeRid;
     dataType: ObjectPropertyType;
+    typeClasses: Array<TypeClass>;
 }
 /**
  * The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.
@@ -5372,6 +5544,12 @@ export type TimeSeriesValueBankProperty = LooselyBrandedString<"TimeSeriesValueB
  * Log Safety: SAFE
  */
 export type TimeSeriesWindowType = "START" | "END";
+/**
+ * Log Safety: UNSAFE
+ */
+export interface TimestampValue {
+    value: string;
+}
 /**
  * Log Safety: SAFE
  */
@@ -5397,6 +5575,15 @@ export interface TwoDimensionalAggregation {
     keyType: QueryAggregationKeyType;
     valueType: QueryAggregationValueType;
 }
+/**
+ * Additional metadata that can be interpreted by user applications that interact with the Ontology
+ *
+ * Log Safety: UNSAFE
+ */
+export interface TypeClass {
+    kind: string;
+    name: string;
+}
 /**
    * 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.