@osdk/foundry.ontologies 2.45.0 → 2.47.0

package/build/esm/_components.d.ts

@@ -126,6 +126,7 @@ export interface ActionParameterV2 {
     description?: string;
     dataType: ActionParameterType;
     required: boolean;
+    typeClasses: Array<TypeClass>;
 }
 /**
  * Log Safety: UNSAFE
@@ -592,6 +593,8 @@ export interface AnyTermQuery {
     fuzzy?: Fuzzy;
 }
 /**
+ * If not specified, defaults to VALIDATE_AND_EXECUTE.
+ *
  * Log Safety: SAFE
  */
 export type ApplyActionMode = "VALIDATE_ONLY" | "VALIDATE_AND_EXECUTE";
@@ -907,6 +910,8 @@ export interface BatchedFunctionLogicRule {
     functionRule: FunctionLogicRule;
 }
 /**
+ * If not specified, defaults to NONE.
+ *
  * Log Safety: SAFE
  */
 export type BatchReturnEditsMode = "ALL" | "NONE";
@@ -917,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.
  *
@@ -1069,6 +1080,12 @@ export interface CountAggregationV2 {
 export interface CountObjectsResponseV2 {
     count?: number;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateEdit {
+    properties: Record<PropertyApiName, PropertyValue>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1256,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.
  *
@@ -1264,6 +1287,12 @@ export interface DatetimeTimezoneUser {
 export interface DecryptionResult {
     plaintext?: Plaintext;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface DeleteEdit {
+    previousProperties: Record<PropertyApiName, PropertyValue>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1437,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.
@@ -1472,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
  */
@@ -1638,6 +1701,19 @@ export type Fuzzy = boolean;
  * Log Safety: SAFE
  */
 export type FuzzyV2 = boolean;
+/**
+ * A single geotemporal data point representing the location of an entity at a specific point in time.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface GeotemporalSeriesEntry {
+    time: string;
+    position: _Geo.GeoPoint;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export type GeotemporalSeriesProperty = LooselyBrandedString<"GeotemporalSeriesProperty">;
 /**
  * The unique id of a geotime series (track) associated with a GTSR.
  *
@@ -1761,6 +1837,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.
@@ -1775,6 +1857,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
@@ -1924,6 +2007,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).
@@ -2496,6 +2580,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.
  *
@@ -2606,6 +2696,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
  */
@@ -2916,6 +3014,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
  */
@@ -2957,6 +3068,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.
  *
@@ -3280,6 +3395,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
  */
@@ -3300,6 +3441,8 @@ export type ObjectTypeId = LooselyBrandedString<"ObjectTypeId">;
  * Log Safety: UNSAFE
  */
 export interface ObjectTypeInterfaceImplementation {
+    apiName?: InterfaceTypeApiName;
+    rid?: InterfaceTypeRid;
     properties: Record<SharedPropertyTypeApiName, PropertyApiName>;
     propertiesV2: Record<InterfacePropertyApiName, InterfacePropertyTypeImplementation>;
     links: Record<InterfaceLinkTypeApiName, Array<LinkTypeApiName>>;
@@ -3581,6 +3724,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
@@ -3773,6 +3920,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.
  *
@@ -3988,6 +4153,8 @@ export type PropertyTypeReferenceOrStringConstant = ({
     type: "propertyType";
 } & PropertyTypeReference);
 /**
+ * The unique resource identifier of a property.
+ *
  * Log Safety: SAFE
  */
 export type PropertyTypeRid = LooselyBrandedString<"PropertyTypeRid">;
@@ -4023,6 +4190,7 @@ export interface PropertyV2 {
     visibility?: PropertyTypeVisibility;
     valueTypeApiName?: ValueTypeApiName;
     valueFormatting?: PropertyValueFormattingRule;
+    typeClasses: Array<TypeClass>;
 }
 /**
    * Represents the value of a property in the following format.
@@ -4498,6 +4666,8 @@ export interface ResolvedInterfacePropertyType {
     requireImplementation: boolean;
 }
 /**
+ * If not specified, defaults to NONE.
+ *
  * Log Safety: SAFE
  */
 export type ReturnEditsMode = "ALL" | "ALL_V2_WITH_DELETIONS" | "NONE";
@@ -4883,6 +5053,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
@@ -4917,6 +5088,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.
@@ -4988,6 +5171,12 @@ export interface StringRegexMatchConstraint {
     regex: string;
     configuredFailureMessage?: string;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface StringValue {
+    value: string;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -5080,6 +5269,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.
@@ -5351,6 +5541,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
  */
@@ -5376,6 +5572,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.