@osdk/foundry.ontologies 2.24.0 → 2.26.0

package/build/esm/_components.d.ts

@@ -161,6 +161,15 @@ export interface AddLink {
     aSideObject: LinkSideObject;
     bSideObject: LinkSideObject;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface AddLinkEdit {
+    objectType: ObjectTypeApiName;
+    primaryKey: PrimaryKeyValue;
+    linkType: LinkTypeApiName;
+    linkedObjectPrimaryKey: PrimaryKeyValue;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -168,6 +177,14 @@ export interface AddObject {
     primaryKey: PropertyValue;
     objectType: ObjectTypeApiName;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface AddObjectEdit {
+    objectType: ObjectTypeApiName;
+    primaryKey: PropertyValue;
+    properties: Record<PropertyApiName, DataValue>;
+}
 /**
  * Adds two or more numeric values.
  *
@@ -184,6 +201,7 @@ export interface AggregateObjectSetRequestV2 {
     objectSet: ObjectSet;
     groupBy: Array<AggregationGroupByV2>;
     accuracy?: AggregationAccuracyRequest;
+    includeComputeUsage?: _Core.IncludeComputeUsage;
 }
 /**
  * Log Safety: UNSAFE
@@ -221,7 +239,7 @@ export interface AggregateObjectsResponseItem {
  * Log Safety: UNSAFE
  */
 export interface AggregateObjectsResponseItemV2 {
-    group: Record<AggregationGroupKeyV2, AggregationGroupValueV2>;
+    group: Record<AggregationGroupKeyV2, AggregationGroupValueV2 | undefined>;
     metrics: Array<AggregationMetricResultV2>;
 }
 /**
@@ -231,6 +249,7 @@ export interface AggregateObjectsResponseV2 {
     excludedItems?: number;
     accuracy: AggregationAccuracy;
     data: Array<AggregateObjectsResponseItemV2>;
+    computeUsage?: _Core.ComputeSeconds;
 }
 /**
  * Log Safety: UNSAFE
@@ -304,6 +323,7 @@ export interface AggregationExactGroupingV2 {
     field: PropertyApiName;
     maxGroupCount?: number;
     defaultValue?: string;
+    includeNullValues?: boolean;
 }
 /**
  * Divides objects into groups with the specified width.
@@ -565,6 +585,15 @@ export interface Arg {
     name: string;
     value: string;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ArrayConstraint {
+    minimumSize?: number;
+    maximumSize?: number;
+    uniqueValues: boolean;
+    valueConstraint?: ValueTypeConstraint;
+}
 /**
  * Evaluated constraints for entries of array parameters for which per-entry evaluation is supported.
  *
@@ -962,7 +991,7 @@ export type CustomTypeId = LooselyBrandedString<"CustomTypeId">;
 | Null                                | null                                                  | null                                                                                                                                                        |
 | Object Set                          | string OR the object set definition                   | ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z                                                                                |
 | Ontology Object Reference           | JSON encoding of the object's primary key             | 10033123 or "EMP1234"                                                                                                                                     |
-| Ontology Interface Object Reference | JSON encoding of the object's api name and primary key| {"objectTypeApiName":"Employee", "primaryKeyValue":"EMP1234"}                                                                                               |
+| Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| {"objectTypeApiName":"Employee", "primaryKeyValue":"EMP1234"}                                                                                               |
 | Ontology Object Type Reference      | string of the object type's api name                  | "Employee"                                                                                                                                                  |
 | Set                                 | array                                                 | ["alpha", "bravo", "charlie"]                                                                                                                               |
 | Short                               | number                                                | 8739                                                                                                                                                        |
@@ -998,6 +1027,15 @@ export interface DeleteLink {
     aSideObject: LinkSideObject;
     bSideObject: LinkSideObject;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface DeleteLinkEdit {
+    objectType: ObjectTypeApiName;
+    primaryKey: PrimaryKeyValue;
+    linkType: LinkTypeApiName;
+    linkedObjectPrimaryKey: PrimaryKeyValue;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1014,6 +1052,13 @@ export interface DeleteObject {
     primaryKey: PropertyValue;
     objectType: ObjectTypeApiName;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface DeleteObjectEdit {
+    objectType: ObjectTypeApiName;
+    primaryKey: PropertyValue;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1129,6 +1174,12 @@ export interface EntrySetType {
     keyType: QueryDataType;
     valueType: QueryDataType;
 }
+/**
+ * Log Safety: SAFE
+ */
+export interface EnumConstraint {
+    options: Array<any>;
+}
 /**
  * Returns objects where the specified field is equal to a value.
  *
@@ -1515,6 +1566,13 @@ export interface IsNullQueryV2 {
 export interface LeastPropertyExpression {
     properties: Array<DerivedPropertyDefinition>;
 }
+/**
+ * Log Safety: SAFE
+ */
+export interface LengthConstraint {
+    minimumLength?: number;
+    maximumLength?: number;
+}
 /**
  * A reference to the linked interface type.
  *
@@ -1670,6 +1728,19 @@ export interface ListOntologiesResponse {
 export interface ListOntologiesV2Response {
     data: Array<OntologyV2>;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ListOntologyValueTypesResponse {
+    data: Array<OntologyValueType>;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ListOutgoingInterfaceLinkTypesResponse {
+    nextPageToken?: _Core.PageToken;
+    data: Array<InterfaceLinkType>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -1711,6 +1782,7 @@ export interface LoadObjectSetRequestV2 {
     pageSize?: _Core.PageSize;
     excludeRid?: boolean;
     snapshot?: boolean;
+    includeComputeUsage?: _Core.IncludeComputeUsage;
 }
 /**
  * Represents the API response when loading an ObjectSet.
@@ -1721,6 +1793,7 @@ export interface LoadObjectSetResponseV2 {
     data: Array<OntologyObjectV2>;
     nextPageToken?: _Core.PageToken;
     totalCount: _Core.TotalCount;
+    computeUsage?: _Core.ComputeSeconds;
 }
 /**
  * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsMultipleObjectTypes endpoint only.
@@ -1735,6 +1808,7 @@ export interface LoadObjectSetV2MultipleObjectTypesRequest {
     pageSize?: _Core.PageSize;
     excludeRid?: boolean;
     snapshot?: boolean;
+    includeComputeUsage?: _Core.IncludeComputeUsage;
 }
 /**
    * Represents the API response when loading an ObjectSet. An interfaceToObjectTypeMappings field is
@@ -1752,6 +1826,7 @@ export interface LoadObjectSetV2MultipleObjectTypesResponse {
     nextPageToken?: _Core.PageToken;
     totalCount: _Core.TotalCount;
     interfaceToObjectTypeMappings: Record<InterfaceTypeApiName, InterfaceToObjectTypeMappings>;
+    computeUsage?: _Core.ComputeSeconds;
 }
 /**
  * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsOrInterfaces endpoint only.
@@ -1917,6 +1992,14 @@ export interface ModifyObject {
     primaryKey: PropertyValue;
     objectType: ObjectTypeApiName;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ModifyObjectEdit {
+    objectType: ObjectTypeApiName;
+    primaryKey: PropertyValue;
+    properties: Record<PropertyApiName, DataValue>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2006,6 +2089,15 @@ export interface ObjectEdits {
     addedLinksCount: number;
     deletedLinksCount: number;
 }
+/**
+ * An object identifier containing an object type API name and primary key.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface ObjectLocator {
+    objectTypeApiName: ObjectTypeApiName;
+    primaryKeyValue: PrimaryKeyValue;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2480,6 +2572,7 @@ export interface OntologyFullMetadata {
     queryTypes: Record<VersionedQueryTypeApiName, QueryTypeV2>;
     interfaceTypes: Record<InterfaceTypeApiName, InterfaceType>;
     sharedPropertyTypes: Record<SharedPropertyTypeApiName, SharedPropertyType>;
+    branch?: _Core.BranchMetadata;
 }
 /**
  * Either an ontology rid or an ontology api name.
@@ -2494,9 +2587,15 @@ export type OntologyInterface = LooselyBrandedString<"OntologyInterface">;
 /**
  * Log Safety: UNSAFE
  */
-export interface OntologyInterfaceObjectType {
+export interface OntologyInterfaceObjectSetType {
     interfaceTypeApiName: InterfaceTypeApiName;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface OntologyInterfaceObjectType {
+    interfaceTypeApiName?: InterfaceTypeApiName;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2575,6 +2674,16 @@ export interface OntologyStructField {
 export interface OntologyStructType {
     fields: Array<OntologyStructField>;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export type OntologyTransaction = LooselyBrandedString<"OntologyTransaction">;
+/**
+ * The RID identifying a transaction.
+ *
+ * Log Safety: SAFE
+ */
+export type OntologyTransactionRid = LooselyBrandedString<"OntologyTransactionRid">;
 /**
  * Metadata about an Ontology.
  *
@@ -2586,6 +2695,19 @@ export interface OntologyV2 {
     description: string;
     rid: OntologyRid;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface OntologyValueType {
+    apiName: ValueTypeApiName;
+    displayName: _Core.DisplayName;
+    description?: string;
+    rid: ValueTypeRid;
+    status?: ValueTypeStatus;
+    fieldType: ValueTypeFieldType;
+    version: string;
+    constraints: Array<ValueTypeConstraint>;
+}
 /**
    * 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
@@ -2718,6 +2840,19 @@ export type Plaintext = LooselyBrandedString<"Plaintext">;
 export type PolygonValue = {
     type: "Polygon";
 } & _Geo.Polygon;
+/**
+ * The request payload for staging edits to a transaction.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface PostTransactionEditsRequest {
+    edits: Array<TransactionEdit>;
+}
+/**
+ * Log Safety: SAFE
+ */
+export interface PostTransactionEditsResponse {
+}
 /**
  * A measurement of duration.
  *
@@ -3001,6 +3136,8 @@ export interface QueryArrayType {
 export type QueryDataType = ({
     type: "date";
 } & _Core.DateType) | ({
+    type: "interfaceObject";
+} & OntologyInterfaceObjectType) | ({
     type: "struct";
 } & QueryStructType) | ({
     type: "set";
@@ -3035,6 +3172,8 @@ export type QueryDataType = ({
 } & OntologyObjectSetType) | ({
     type: "twoDimensionalAggregation";
 } & TwoDimensionalAggregation) | ({
+    type: "interfaceObjectSet";
+} & OntologyInterfaceObjectSetType) | ({
     type: "object";
 } & OntologyObjectType) | ({
     type: "timestamp";
@@ -3137,6 +3276,13 @@ export interface RangeConstraint {
     gt?: any;
     gte?: any;
 }
+/**
+ * Log Safety: SAFE
+ */
+export interface RangesConstraint {
+    minimumValue?: any;
+    maximumValue?: any;
+}
 /**
  * Log Safety: SAFE
  */
@@ -3179,6 +3325,13 @@ export interface RefreshObjectSet {
     id: SubscriptionId;
     objectType: ObjectTypeApiName;
 }
+/**
+ * Log Safety: SAFE
+ */
+export interface RegexConstraint {
+    pattern: string;
+    partialMatch: boolean;
+}
 /**
  * A relative time, such as "3 days before" or "2 hours after" the current moment.
  *
@@ -3216,6 +3369,13 @@ export type RequestId = string;
  * Log Safety: SAFE
  */
 export type ReturnEditsMode = "ALL" | "ALL_V2_WITH_DELETIONS" | "NONE";
+/**
+ * The string must be a valid RID (Resource Identifier).
+ *
+ * Log Safety: SAFE
+ */
+export interface RidConstraint {
+}
 /**
  * Number of points in each window.
  *
@@ -3662,12 +3822,20 @@ export interface StringRegexMatchConstraint {
     regex: string;
     configuredFailureMessage?: string;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface StructConstraint {
+    properties: Record<PropertyApiName, ValueTypeApiName>;
+}
 /**
  * Represents the validity of a singleton struct parameter.
  *
  * Log Safety: UNSAFE
  */
-export type StructEvaluatedConstraint = Record<StructParameterFieldApiName, StructFieldEvaluationResult>;
+export interface StructEvaluatedConstraint {
+    structFields: Record<StructParameterFieldApiName, StructFieldEvaluationResult>;
+}
 /**
  * The name of a struct field in the Ontology.
  *
@@ -3961,6 +4129,20 @@ export type TimeSeriesWindowType = "START" | "END";
  * Log Safety: SAFE
  */
 export type TimeUnit = "MILLISECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "QUARTERS";
+/**
+ * Log Safety: UNSAFE
+ */
+export type TransactionEdit = ({
+    type: "modifyObject";
+} & ModifyObjectEdit) | ({
+    type: "deleteObject";
+} & DeleteObjectEdit) | ({
+    type: "addObject";
+} & AddObjectEdit) | ({
+    type: "removeLink";
+} & DeleteLinkEdit) | ({
+    type: "addLink";
+} & AddLinkEdit);
 /**
  * Log Safety: UNSAFE
  */
@@ -3976,6 +4158,13 @@ This can happen when a parameter's allowed values are defined by another paramet
    */
 export interface UnevaluableConstraint {
 }
+/**
+ * The string must be a valid UUID (Universally Unique Identifier).
+ *
+ * Log Safety: SAFE
+ */
+export interface UuidConstraint {
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -4031,6 +4220,128 @@ structs.
    * Log Safety: SAFE
    */
 export type ValueType = LooselyBrandedString<"ValueType">;
+/**
+ * The name of the value type in the API in camelCase format.
+ *
+ * Log Safety: UNSAFE
+ */
+export type ValueTypeApiName = LooselyBrandedString<"ValueTypeApiName">;
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ValueTypeArrayType {
+    subType?: ValueTypeFieldType;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export type ValueTypeConstraint = ({
+    type: "struct";
+} & StructConstraint) | ({
+    type: "regex";
+} & RegexConstraint) | ({
+    type: "array";
+} & ArrayConstraint) | ({
+    type: "length";
+} & LengthConstraint) | ({
+    type: "range";
+} & RangesConstraint) | ({
+    type: "rid";
+} & RidConstraint) | ({
+    type: "uuid";
+} & UuidConstraint) | ({
+    type: "enum";
+} & EnumConstraint);
+/**
+ * Log Safety: SAFE
+ */
+export interface ValueTypeDecimalType {
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export type ValueTypeFieldType = ({
+    type: "date";
+} & _Core.DateType) | ({
+    type: "struct";
+} & ValueTypeStructType) | ({
+    type: "string";
+} & _Core.StringType) | ({
+    type: "byte";
+} & _Core.ByteType) | ({
+    type: "double";
+} & _Core.DoubleType) | ({
+    type: "optional";
+} & ValueTypeOptionalType) | ({
+    type: "integer";
+} & _Core.IntegerType) | ({
+    type: "union";
+} & ValueTypeUnionType) | ({
+    type: "float";
+} & _Core.FloatType) | ({
+    type: "long";
+} & _Core.LongType) | ({
+    type: "reference";
+} & ValueTypeReferenceType) | ({
+    type: "boolean";
+} & _Core.BooleanType) | ({
+    type: "array";
+} & ValueTypeArrayType) | ({
+    type: "binary";
+} & _Core.BinaryType) | ({
+    type: "short";
+} & _Core.ShortType) | ({
+    type: "decimal";
+} & ValueTypeDecimalType) | ({
+    type: "map";
+} & ValueTypeMapType) | ({
+    type: "timestamp";
+} & _Core.TimestampType);
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ValueTypeMapType {
+    keyType?: ValueTypeFieldType;
+    valueType?: ValueTypeFieldType;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ValueTypeOptionalType {
+    wrappedType?: ValueTypeFieldType;
+}
+/**
+ * Log Safety: SAFE
+ */
+export interface ValueTypeReferenceType {
+}
+/**
+ * Log Safety: SAFE
+ */
+export type ValueTypeRid = LooselyBrandedString<"ValueTypeRid">;
+/**
+ * Log Safety: SAFE
+ */
+export type ValueTypeStatus = "ACTIVE" | "DEPRECATED";
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ValueTypeStructField {
+    name?: _Core.StructFieldName;
+    fieldType?: ValueTypeFieldType;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ValueTypeStructType {
+    fields: Array<ValueTypeStructField>;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ValueTypeUnionType {
+    memberTypes: Array<ValueTypeFieldType>;
+}
 /**
    * The name of the Query in the API and an optional version identifier separated by a colon.
 If the API name contains a colon, then a version identifier of either "latest" or a semantic version must