@osdk/foundry.ontologies 2.32.0 → 2.33.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @osdk/foundry.ontologies
 
+## 2.33.0
+
+### Minor Changes
+
+- 3b147c5: Bump sdks
+
+### Patch Changes
+
+- Updated dependencies [3b147c5]
+  - @osdk/foundry.core@2.33.0
+  - @osdk/foundry.geo@2.33.0
+
 ## 2.32.0
 
 ### Minor Changes

package/build/browser/_components.d.ts

@@ -24,6 +24,38 @@ export interface AbsoluteValuePropertyExpression {
  * Log Safety: UNSAFE
  */
 export type Action = LooselyBrandedString<"Action">;
+/**
+ * A detailed operation for an Action
+ *
+ * Log Safety: UNSAFE
+ */
+export type ActionLogicRule = ({
+    type: "modifyInterface";
+} & ModifyInterfaceLogicRule) | ({
+    type: "createOrModifyObject";
+} & CreateOrModifyObjectLogicRule) | ({
+    type: "modifyObject";
+} & ModifyObjectLogicRule) | ({
+    type: "deleteLink";
+} & DeleteLinkLogicRule) | ({
+    type: "createObject";
+} & CreateObjectLogicRule) | ({
+    type: "createLink";
+} & CreateLinkLogicRule) | ({
+    type: "batchedFunction";
+} & BatchedFunctionLogicRule) | ({
+    type: "createOrModifyObjectV2";
+} & CreateOrModifyObjectLogicRuleV2) | ({
+    type: "deleteInterfaceLink";
+} & DeleteInterfaceLinkLogicRule) | ({
+    type: "deleteObject";
+} & DeleteObjectLogicRule) | ({
+    type: "function";
+} & FunctionLogicRule) | ({
+    type: "createInterfaceLink";
+} & CreateInterfaceLinkLogicRule) | ({
+    type: "createInterface";
+} & CreateInterfaceLogicRule);
 /**
  * Log Safety: SAFE
  */
@@ -124,6 +156,15 @@ endpoint or check the Ontology Manager.
    * Log Safety: UNSAFE
    */
 export type ActionTypeApiName = LooselyBrandedString<"ActionTypeApiName">;
+/**
+ * Returns the full metadata for an Action type in the Ontology.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface ActionTypeFullMetadata {
+    actionType: ActionTypeV2;
+    fullLogicRule: ActionLogicRule;
+}
 /**
  * The unique resource identifier of an action type, useful for interacting with other Foundry APIs.
  *
@@ -799,6 +840,13 @@ export interface BatchApplyActionResponse {
 export interface BatchApplyActionResponseV2 {
     edits?: BatchActionResults;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface BatchedFunctionLogicRule {
+    objectSetRidInputName: FunctionParameterName;
+    functionRule: FunctionLogicRule;
+}
 /**
  * Log Safety: SAFE
  */
@@ -932,12 +980,38 @@ export interface CountAggregationV2 {
 export interface CountObjectsResponseV2 {
     count?: number;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateInterfaceLinkLogicRule {
+    interfaceTypeApiName: InterfaceTypeApiName;
+    interfaceLinkTypeApiName: InterfaceLinkTypeApiName;
+    sourceObject: ParameterId;
+    targetObject: ParameterId;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateInterfaceLogicRule {
+    interfaceTypeApiName: InterfaceTypeApiName;
+    objectType: ParameterId;
+    sharedPropertyArguments: Record<SharedPropertyTypeApiName, LogicRuleArgument>;
+    structPropertyArguments: Record<SharedPropertyTypeApiName, Record<StructFieldApiName, StructFieldArgument>>;
+}
 /**
  * Log Safety: UNSAFE
  */
 export interface CreateInterfaceObjectRule {
     interfaceTypeApiName: InterfaceTypeApiName;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateLinkLogicRule {
+    linkTypeApiName: LinkTypeApiName;
+    sourceObject: ParameterId;
+    targetObject: ParameterId;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -947,12 +1021,36 @@ export interface CreateLinkRule {
     aSideObjectTypeApiName: ObjectTypeApiName;
     bSideObjectTypeApiName: ObjectTypeApiName;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateObjectLogicRule {
+    objectTypeApiName: ObjectTypeApiName;
+    propertyArguments: Record<PropertyApiName, LogicRuleArgument>;
+    structPropertyArguments: Record<PropertyApiName, Record<StructFieldApiName, StructFieldArgument>>;
+}
 /**
  * Log Safety: UNSAFE
  */
 export interface CreateObjectRule {
     objectTypeApiName: ObjectTypeApiName;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateOrModifyObjectLogicRule {
+    objectTypeApiName: ObjectTypeApiName;
+    propertyArguments: Record<PropertyApiName, LogicRuleArgument>;
+    structPropertyArguments: Record<PropertyApiName, Record<StructFieldApiName, StructFieldArgument>>;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateOrModifyObjectLogicRuleV2 {
+    objectToModify: ParameterId;
+    propertyArguments: Record<PropertyApiName, LogicRuleArgument>;
+    structPropertyArguments: Record<PropertyApiName, Record<StructFieldApiName, StructFieldArgument>>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -965,6 +1063,20 @@ export interface CreateTemporaryObjectSetRequestV2 {
 export interface CreateTemporaryObjectSetResponseV2 {
     objectSetRid: ObjectSetRid;
 }
+/**
+ * Represents the current time argument in a logic rule.
+ *
+ * Log Safety: SAFE
+ */
+export interface CurrentTimeArgument {
+}
+/**
+ * Represents the current user argument in a logic rule.
+ *
+ * Log Safety: SAFE
+ */
+export interface CurrentUserArgument {
+}
 /**
  * A UUID representing a custom type in a given Function.
  *
@@ -1012,6 +1124,15 @@ export type DataValue = any;
 export interface DecryptionResult {
     plaintext?: Plaintext;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface DeleteInterfaceLinkLogicRule {
+    interfaceTypeApiName: InterfaceTypeApiName;
+    interfaceLinkTypeApiName: InterfaceLinkTypeApiName;
+    sourceObject: ParameterId;
+    targetObject: ParameterId;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1036,6 +1157,14 @@ export interface DeleteLinkEdit {
     linkType: LinkTypeApiName;
     linkedObjectPrimaryKey: PrimaryKeyValue;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface DeleteLinkLogicRule {
+    linkTypeApiName: LinkTypeApiName;
+    sourceObject: ParameterId;
+    targetObject: ParameterId;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1059,6 +1188,12 @@ export interface DeleteObjectEdit {
     objectType: ObjectTypeApiName;
     primaryKey: PropertyValue;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface DeleteObjectLogicRule {
+    objectToDelete: ParameterId;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1274,6 +1409,20 @@ properties.{propertyApiName}.isNull=false.
    * Log Safety: UNSAFE
    */
 export type FilterValue = LooselyBrandedString<"FilterValue">;
+/**
+ * Log Safety: UNSAFE
+ */
+export interface FunctionLogicRule {
+    functionRid: FunctionRid;
+    functionVersion: FunctionVersion;
+    functionInputValues: Record<FunctionParameterName, LogicRuleArgument>;
+}
+/**
+ * The name of an input to a function.
+ *
+ * Log Safety: UNSAFE
+ */
+export type FunctionParameterName = LooselyBrandedString<"FunctionParameterName">;
 /**
  * The unique resource identifier of a Function, useful for interacting with other Foundry APIs.
  *
@@ -1459,6 +1608,15 @@ export type InterfaceLinkTypeLinkedEntityApiName = ({
  * Log Safety: SAFE
  */
 export type InterfaceLinkTypeRid = LooselyBrandedString<"InterfaceLinkTypeRid">;
+/**
+ * Represents an interface parameter property argument in a logic rule.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface InterfaceParameterPropertyArgument {
+    parameterId: ParameterId;
+    sharedPropertyTypeRid: string;
+}
 /**
    * A shared property type with an additional field to indicate whether the property must be included on every
 object type that implements the interface, or whether it is optional.
@@ -1918,6 +2076,28 @@ export type LogicRule = ({
 } & CreateObjectRule) | ({
     type: "createLink";
 } & CreateLinkRule);
+/**
+ * Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value.
+ *
+ * Log Safety: UNSAFE
+ */
+export type LogicRuleArgument = ({
+    type: "currentTime";
+} & CurrentTimeArgument) | ({
+    type: "staticValue";
+} & StaticArgument) | ({
+    type: "currentUser";
+} & CurrentUserArgument) | ({
+    type: "parameterId";
+} & ParameterIdArgument) | ({
+    type: "interfaceParameterPropertyValue";
+} & InterfaceParameterPropertyArgument) | ({
+    type: "synchronousWebhookOutput";
+} & SynchronousWebhookOutputArgument) | ({
+    type: "objectParameterPropertyValue";
+} & ObjectParameterPropertyArgument) | ({
+    type: "uniqueIdentifier";
+} & UniqueIdentifierArgument);
 /**
  * Returns objects where the specified field is less than or equal to a value.
  *
@@ -2012,6 +2192,14 @@ export interface MinAggregationV2 {
     name?: AggregationMetricName;
     direction?: OrderByDirection;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ModifyInterfaceLogicRule {
+    interfaceObjectToModify: ParameterId;
+    sharedPropertyArguments: Record<SharedPropertyTypeApiName, LogicRuleArgument>;
+    structPropertyArguments: Record<SharedPropertyTypeApiName, Record<StructFieldApiName, StructFieldArgument>>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2033,6 +2221,14 @@ export interface ModifyObjectEdit {
     primaryKey: PropertyValue;
     properties: Record<PropertyApiName, DataValue>;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ModifyObjectLogicRule {
+    objectToModify: ParameterId;
+    propertyArguments: Record<PropertyApiName, LogicRuleArgument>;
+    structPropertyArguments: Record<PropertyApiName, Record<StructFieldApiName, StructFieldArgument>>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2131,6 +2327,15 @@ export interface ObjectLocator {
     objectTypeApiName: ObjectTypeApiName;
     primaryKeyValue: PrimaryKeyValue;
 }
+/**
+ * Represents an object parameter property argument in a logic rule.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface ObjectParameterPropertyArgument {
+    parameterId: ParameterId;
+    propertyTypeApiName: PropertyTypeApiName;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2848,6 +3053,14 @@ Parameters can be viewed and managed in the Ontology Manager.
    * Log Safety: UNSAFE
    */
 export type ParameterId = LooselyBrandedString<"ParameterId">;
+/**
+ * Represents a parameter ID argument in a logic rule.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface ParameterIdArgument {
+    parameterId: ParameterId;
+}
 /**
  * A possible value for the parameter. This is defined in the Ontology Manager by Actions admins.
  *
@@ -3370,6 +3583,18 @@ export interface RegexConstraint {
     pattern: string;
     partialMatch: boolean;
 }
+/**
+   * Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed
+form of text fields and supports standard regex syntax of dot (.), star(*) and question mark(?).
+Either field or propertyIdentifier can be supplied, but not both.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface RegexQuery {
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
+    value: string;
+}
 /**
  * A relative time, such as "3 days before" or "2 hours after" the current moment.
  *
@@ -3470,42 +3695,24 @@ export type SearchJsonQuery = ({
  * Log Safety: UNSAFE
  */
 export type SearchJsonQueryV2 = ({
-    type: "or";
-} & OrQueryV2) | ({
-    type: "in";
-} & InQuery) | ({
-    type: "doesNotIntersectPolygon";
-} & DoesNotIntersectPolygonQuery) | ({
     type: "lt";
 } & LtQueryV2) | ({
     type: "doesNotIntersectBoundingBox";
 } & DoesNotIntersectBoundingBoxQuery) | ({
-    type: "eq";
-} & EqualsQueryV2) | ({
-    type: "containsAllTerms";
-} & ContainsAllTermsQuery) | ({
-    type: "gt";
-} & GtQueryV2) | ({
     type: "wildcard";
 } & WildcardQuery) | ({
     type: "withinDistanceOf";
 } & WithinDistanceOfQuery) | ({
     type: "withinBoundingBox";
 } & WithinBoundingBoxQuery) | ({
-    type: "contains";
-} & ContainsQueryV2) | ({
     type: "not";
 } & NotQueryV2) | ({
     type: "intersectsBoundingBox";
 } & IntersectsBoundingBoxQuery) | ({
     type: "and";
 } & AndQueryV2) | ({
-    type: "isNull";
-} & IsNullQueryV2) | ({
     type: "containsAllTermsInOrderPrefixLastTerm";
 } & ContainsAllTermsInOrderPrefixLastTerm) | ({
-    type: "containsAnyTerm";
-} & ContainsAnyTermQuery) | ({
     type: "gte";
 } & GteQueryV2) | ({
     type: "containsAllTermsInOrder";
@@ -3516,6 +3723,26 @@ export type SearchJsonQueryV2 = ({
 } & IntersectsPolygonQuery) | ({
     type: "lte";
 } & LteQueryV2) | ({
+    type: "or";
+} & OrQueryV2) | ({
+    type: "in";
+} & InQuery) | ({
+    type: "doesNotIntersectPolygon";
+} & DoesNotIntersectPolygonQuery) | ({
+    type: "eq";
+} & EqualsQueryV2) | ({
+    type: "containsAllTerms";
+} & ContainsAllTermsQuery) | ({
+    type: "gt";
+} & GtQueryV2) | ({
+    type: "contains";
+} & ContainsQueryV2) | ({
+    type: "regex";
+} & RegexQuery) | ({
+    type: "isNull";
+} & IsNullQueryV2) | ({
+    type: "containsAnyTerm";
+} & ContainsAnyTermQuery) | ({
     type: "startsWith";
 } & StartsWithQuery);
 /**
@@ -3798,6 +4025,14 @@ export interface StartsWithQuery {
     propertyIdentifier?: PropertyIdentifier;
     value: string;
 }
+/**
+ * Represents a static argument in a logic rule.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface StaticArgument {
+    value: DataValue;
+}
 /**
    * Which format to serialize the binary stream in.
 ARROW is more efficient for streaming a large sized response.
@@ -3883,6 +4118,16 @@ export interface StructEvaluatedConstraint {
  * Log Safety: UNSAFE
  */
 export type StructFieldApiName = LooselyBrandedString<"StructFieldApiName">;
+/**
+ * Represents an argument used for an individual struct field.
+ *
+ * Log Safety: UNSAFE
+ */
+export type StructFieldArgument = ({
+    type: "structListParameterFieldValue";
+} & StructListParameterFieldArgument) | ({
+    type: "structParameterFieldValue";
+} & StructParameterFieldArgument);
 /**
    * A constraint that an action struct parameter field value must satisfy in order to be considered valid.
 Constraints can be configured on fields of struct parameters in the Ontology Manager.
@@ -3943,12 +4188,30 @@ export interface StructFieldType {
  * Log Safety: SAFE
  */
 export type StructFieldTypeRid = LooselyBrandedString<"StructFieldTypeRid">;
+/**
+ * Represents a struct list parameter field argument in a logic rule.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface StructListParameterFieldArgument {
+    parameterId: ParameterId;
+    structParameterFieldApiName: StructParameterFieldApiName;
+}
 /**
  * The unique identifier of the struct parameter field.
  *
  * Log Safety: UNSAFE
  */
 export type StructParameterFieldApiName = LooselyBrandedString<"StructParameterFieldApiName">;
+/**
+ * Represents a struct parameter field argument in a logic rule.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface StructParameterFieldArgument {
+    parameterId: ParameterId;
+    structParameterFieldApiName: StructParameterFieldApiName;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -4036,6 +4299,14 @@ export interface SyncApplyActionResponseV2 {
     validation?: ValidateActionResponseV2;
     edits?: ActionResults;
 }
+/**
+ * Represents a synchronous webhook output argument in a logic rule.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface SynchronousWebhookOutputArgument {
+    webhookOutputParamName: string;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -4199,6 +4470,14 @@ This can happen when a parameter's allowed values are defined by another paramet
    */
 export interface UnevaluableConstraint {
 }
+/**
+ * Represents a unique identifier argument in a logic rule.
+ *
+ * Log Safety: SAFE
+ */
+export interface UniqueIdentifierArgument {
+    linkId?: string;
+}
 /**
  * The string must be a valid UUID (Universally Unique Identifier).
  *