@osdk/internal.foundry.ontologies 2.41.0 → 2.43.0

package/build/esm/_components.d.ts

@@ -596,6 +596,20 @@ export interface ApplyActionRequestV2 {
  */
 export interface ApplyActionResponse {
 }
+/**
+ * Performs both apply reducers and extract main value to return the reduced main value.
+ *
+ * Log Safety: SAFE
+ */
+export interface ApplyReducersAndExtractMainValueLoadLevel {
+}
+/**
+ * Returns a single value of an array as configured in the ontology.
+ *
+ * Log Safety: SAFE
+ */
+export interface ApplyReducersLoadLevel {
+}
 /**
  * Computes an approximate number of distinct values for the provided field.
  *
@@ -1465,6 +1479,13 @@ export interface ExperimentalPropertyTypeStatus {
  * Log Safety: SAFE
  */
 export type ExtractDatePart = "DAYS" | "MONTHS" | "QUARTERS" | "YEARS";
+/**
+ * Returns the main value of a struct as configured in the ontology.
+ *
+ * Log Safety: SAFE
+ */
+export interface ExtractMainValueLoadLevel {
+}
 /**
  * Extracts the specified date part from a date or timestamp.
  *
@@ -1733,11 +1754,28 @@ the Ontology Manager.
    */
 export type InterfacePropertyApiName = LooselyBrandedString<"InterfacePropertyApiName">;
 /**
+ * An implementation of an interface property via a local property.
+ *
  * Log Safety: UNSAFE
  */
 export interface InterfacePropertyLocalPropertyImplementation {
     propertyApiName: PropertyApiName;
 }
+/**
+ * An implementation of an interface property via the field of a local struct property.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface InterfacePropertyStructFieldImplementation {
+    structFieldOfProperty: StructFieldOfPropertyImplementation;
+}
+/**
+   * An implementation of a struct interface property via a local struct property. Specifies a mapping of interface
+struct fields to local struct fields or properties.
+   *
+   * Log Safety: UNSAFE
+   */
+export type InterfacePropertyStructImplementation = Record<StructFieldApiName, PropertyOrStructFieldOfPropertyImplementation>;
 /**
    * The definition of an interface property type on an interface. An interface property can either be backed by a
 shared property type or defined on the interface directly.
@@ -1750,14 +1788,17 @@ export type InterfacePropertyType = ({
     type: "interfaceSharedPropertyType";
 } & InterfaceSharedPropertyType);
 /**
-   * Describes how an object type implements an interface property type. For now this is only possible via a single
-local property but this may be extended in the future.
-   *
-   * Log Safety: UNSAFE
-   */
-export type InterfacePropertyTypeImplementation = {
+ * Describes how an object type implements an interface property.
+ *
+ * Log Safety: UNSAFE
+ */
+export type InterfacePropertyTypeImplementation = ({
+    type: "structFieldImplementation";
+} & InterfacePropertyStructFieldImplementation) | ({
+    type: "structImplementation";
+} & InterfacePropertyStructImplementation) | ({
     type: "localPropertyImplementation";
-} & InterfacePropertyLocalPropertyImplementation;
+} & InterfacePropertyLocalPropertyImplementation);
 /**
  * The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.
  *
@@ -1926,6 +1967,17 @@ export interface LengthConstraint {
 export interface LinkedInterfaceTypeApiName {
     apiName: InterfaceTypeApiName;
 }
+/**
+   * Does not contain information about the source object. Should be used in a nested type that provides information about source objects.
+The targetObject Ontology Object in this response will only ever have the __primaryKey and __apiName
+fields present, thus functioning as object locators rather than full objects.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface LinkedObjectLocator {
+    targetObject?: OntologyObjectV2;
+    linkType?: LinkTypeApiName;
+}
 /**
  * A reference to the linked object type.
  *
@@ -1938,6 +1990,16 @@ export interface LinkedObjectTypeApiName {
  * Log Safety: UNSAFE
  */
 export type LinkedObjectV2 = LooselyBrandedString<"LinkedObjectV2">;
+/**
+   * The Ontology Objects in this response will only ever have the __primaryKey and __apiName
+fields present, thus functioning as object locators rather than full objects.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface LinksFromObject {
+    sourceObject?: OntologyObjectV2;
+    linkedObjects: Array<LinkedObjectLocator>;
+}
 /**
  * Log Safety: UNSAFE
  */
@@ -2139,6 +2201,23 @@ export interface ListQueryTypesResponseV2 {
     nextPageToken?: _Core.PageToken;
     data: Array<QueryTypeV2>;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface LoadObjectSetLinksRequestV2 {
+    objectSet: ObjectSet;
+    links: Array<LinkTypeApiName>;
+    pageToken?: _Core.PageToken;
+    includeComputeUsage?: _Core.IncludeComputeUsage;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface LoadObjectSetLinksResponseV2 {
+    data: Array<LinksFromObject>;
+    nextPageToken?: _Core.PageToken;
+    computeUsage?: _Core.ComputeSeconds;
+}
 /**
  * Represents the API POST body when loading an ObjectSet.
  *
@@ -2148,6 +2227,7 @@ export interface LoadObjectSetRequestV2 {
     objectSet: ObjectSet;
     orderBy?: SearchOrderByV2;
     select: Array<SelectedPropertyApiName>;
+    selectV2: Array<PropertyIdentifier>;
     pageToken?: _Core.PageToken;
     pageSize?: _Core.PageSize;
     excludeRid?: boolean;
@@ -2174,6 +2254,7 @@ export interface LoadObjectSetV2MultipleObjectTypesRequest {
     objectSet: ObjectSet;
     orderBy?: SearchOrderByV2;
     select: Array<SelectedPropertyApiName>;
+    selectV2: Array<PropertyIdentifier>;
     pageToken?: _Core.PageToken;
     pageSize?: _Core.PageSize;
     excludeRid?: boolean;
@@ -2189,7 +2270,7 @@ single object set- some objects may have all their properties and some may only
 The interfaceToObjectTypeMappings field contains mappings from SharedPropertyTypeApiNames on the interface(s) to
 PropertyApiName for properties on the object(s).
 The interfaceToObjectTypeMappingsV2 field contains mappings from InterfacePropertyApiNames on the
-interface(s) to InterfacePropertyImplementation for properties on the object(s). This therefore includes
+interface(s) to InterfacePropertyTypeImplementation for properties on the object(s). This therefore includes
 implementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface.
    *
    * Log Safety: UNSAFE
@@ -2211,6 +2292,7 @@ export interface LoadObjectSetV2ObjectsOrInterfacesRequest {
     objectSet: ObjectSet;
     orderBy?: SearchOrderByV2;
     select: Array<SelectedPropertyApiName>;
+    selectV2: Array<PropertyIdentifier>;
     pageToken?: _Core.PageToken;
     pageSize?: _Core.PageSize;
     excludeRid?: boolean;
@@ -3219,7 +3301,19 @@ export interface OntologyObject {
  */
 export interface OntologyObjectArrayType {
     subType: ObjectPropertyType;
+    reducers: Array<OntologyObjectArrayTypeReducer>;
 }
+/**
+ * Log Safety: UNSAFE
+ */
+export interface OntologyObjectArrayTypeReducer {
+    direction: OntologyObjectArrayTypeReducerSortDirection;
+    field?: StructFieldApiName;
+}
+/**
+ * Log Safety: SAFE
+ */
+export type OntologyObjectArrayTypeReducerSortDirection = "ASCENDING_NULLS_LAST" | "DESCENDING_NULLS_LAST";
 /**
  * Log Safety: UNSAFE
  */
@@ -3580,7 +3674,15 @@ export type PropertyIdentifier = ({
     type: "property";
 } & PropertyApiNameSelector) | ({
     type: "structField";
-} & StructFieldSelector);
+} & StructFieldSelector) | ({
+    type: "propertyWithLoadLevel";
+} & PropertyWithLoadLevelSelector);
+/**
+ * Log Safety: UNSAFE
+ */
+export interface PropertyImplementation {
+    propertyApiName: PropertyApiName;
+}
 /**
  * Formatting configuration for known Foundry types.
  *
@@ -3589,6 +3691,22 @@ export type PropertyIdentifier = ({
 export interface PropertyKnownTypeFormattingRule {
     knownType: KnownType;
 }
+/**
+   * The load level of the property:
+
+APPLY_REDUCERS: Returns a single value of an array as configured in the ontology.
+EXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.
+APPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.
+   *
+   * Log Safety: UNSAFE
+   */
+export type PropertyLoadLevel = ({
+    type: "applyReducersAndExtractMainValue";
+} & ApplyReducersAndExtractMainValueLoadLevel) | ({
+    type: "applyReducers";
+} & ApplyReducersLoadLevel) | ({
+    type: "extractMainValue";
+} & ExtractMainValueLoadLevel);
 /**
  * Wrapper for numeric formatting options.
  *
@@ -3619,6 +3737,14 @@ export type PropertyNumberFormattingRuleType = ({
 } & NumberFormatCustomUnit) | ({
     type: "ratio";
 } & NumberFormatRatio);
+/**
+ * Log Safety: UNSAFE
+ */
+export type PropertyOrStructFieldOfPropertyImplementation = ({
+    type: "structFieldOfProperty";
+} & StructFieldOfPropertyImplementation) | ({
+    type: "property";
+} & PropertyImplementation);
 /**
  * Formatting configuration for timestamp property values.
  *
@@ -3743,6 +3869,17 @@ export type PropertyValueFormattingRule = ({
 } & PropertyKnownTypeFormattingRule) | ({
     type: "timestamp";
 } & PropertyTimestampFormattingRule);
+/**
+   * A combination of a property API name and the load level to apply to the property. You can select a reduced value
+for arrays and the main value for structs. If the provided load level cannot be applied to the property type,
+then it will be ignored. This selector is experimental and may not work in filters or sorts.
+   *
+   * Log Safety: UNSAFE
+   */
+export interface PropertyWithLoadLevelSelector {
+    propertyIdentifier: PropertyIdentifier;
+    loadLevel: PropertyLoadLevel;
+}
 /**
  * An error indicating that the subscribe request should be attempted on a different node.
  *
@@ -4059,6 +4196,40 @@ export interface RegexQuery {
     propertyIdentifier?: PropertyIdentifier;
     value: string;
 }
+/**
+ * Specifies a bound for a relative date range query.
+ *
+ * Log Safety: UNSAFE
+ */
+export type RelativeDateRangeBound = {
+    type: "relativePoint";
+} & RelativePointInTime;
+/**
+   * Returns objects where the specified date or timestamp property falls within a relative date range.
+The bounds are calculated relative to query execution time and rounded to midnight in the specified timezone.
+Examples:
+
+Last 7 days: relativeStartTime = {value: -7, timeUnit: DAY}, relativeEndTime = {value: 0, timeUnit: DAY}
+This month: relativeStartTime = {value: 0, timeUnit: MONTH}, relativeEndTime = {value: 1, timeUnit: MONTH}
+   *
+   * Log Safety: UNSAFE
+   */
+export interface RelativeDateRangeQuery {
+    field?: PropertyApiName;
+    propertyIdentifier?: PropertyIdentifier;
+    relativeStartTime?: RelativeDateRangeBound;
+    relativeEndTime?: RelativeDateRangeBound;
+    timeZoneId: string;
+}
+/**
+ * A point in time specified relative to query execution time.
+ *
+ * Log Safety: UNSAFE
+ */
+export interface RelativePointInTime {
+    value: number;
+    timeUnit: RelativeTimeUnit;
+}
 /**
  * A relative time, such as "3 days before" or "2 hours after" the current moment.
  *
@@ -4086,6 +4257,12 @@ export type RelativeTimeRelation = "BEFORE" | "AFTER";
  * Log Safety: SAFE
  */
 export type RelativeTimeSeriesTimeUnit = "MILLISECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS";
+/**
+ * Units for relative time calculations.
+ *
+ * Log Safety: SAFE
+ */
+export type RelativeTimeUnit = "DAY" | "WEEK" | "MONTH" | "YEAR";
 /**
  * Unique request id
  *
@@ -4105,6 +4282,7 @@ export interface ResolvedInterfacePropertyType {
     description?: string;
     dataType: ObjectPropertyType;
     valueTypeApiName?: ValueTypeApiName;
+    valueFormatting?: PropertyValueFormattingRule;
     requireImplementation: boolean;
 }
 /**
@@ -4178,6 +4356,8 @@ export type SearchJsonQueryV2 = ({
 } & LtQueryV2) | ({
     type: "doesNotIntersectBoundingBox";
 } & DoesNotIntersectBoundingBoxQuery) | ({
+    type: "relativeDateRange";
+} & RelativeDateRangeQuery) | ({
     type: "wildcard";
 } & WildcardQuery) | ({
     type: "withinDistanceOf";
@@ -4232,7 +4412,9 @@ export interface SearchObjectsForInterfaceRequest {
     orderBy?: SearchOrderByV2;
     augmentedProperties: Record<ObjectTypeApiName, Array<PropertyApiName>>;
     augmentedSharedPropertyTypes: Record<InterfaceTypeApiName, Array<SharedPropertyTypeApiName>>;
+    augmentedInterfacePropertyTypes: Record<InterfaceTypeApiName, Array<InterfacePropertyApiName>>;
     selectedSharedPropertyTypes: Array<SharedPropertyTypeApiName>;
+    selectedInterfacePropertyTypes: Array<InterfacePropertyApiName>;
     selectedObjectTypes: Array<ObjectTypeApiName>;
     otherInterfaceTypes: Array<InterfaceTypeApiName>;
     pageSize?: _Core.PageSize;
@@ -4257,6 +4439,7 @@ export interface SearchObjectsRequestV2 {
     pageSize?: _Core.PageSize;
     pageToken?: _Core.PageToken;
     select: Array<PropertyApiName>;
+    selectV2: Array<PropertyIdentifier>;
     excludeRid?: boolean;
     snapshot?: boolean;
 }
@@ -4652,10 +4835,16 @@ export interface StructFieldEvaluationResult {
     required: boolean;
 }
 /**
-   * A combination of a property API name and a struct field API name used to select struct fields. Note that you can
-still select struct properties with only a 'PropertyApiNameSelector'; the queries will then become 'OR' queries
-across the fields of the struct property, and derived property expressions will operate on the whole struct
-where applicable.
+ * Log Safety: UNSAFE
+ */
+export interface StructFieldOfPropertyImplementation {
+    propertyApiName: PropertyApiName;
+    structFieldApiName: StructFieldApiName;
+}
+/**
+   * A combination of a property identifier and the load level to apply to the property. You can select a reduced
+value for arrays and the main value for structs. If the provided load level cannot be applied to the property
+type, then it will be ignored. This selector is experimental and may not work in filters or sorts.
    *
    * Log Safety: UNSAFE
    */
@@ -4706,6 +4895,14 @@ export interface StructParameterFieldArgument {
  */
 export interface StructType {
     structFieldTypes: Array<StructFieldType>;
+    mainValue?: StructTypeMainValue;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface StructTypeMainValue {
+    mainValueType: ObjectPropertyType;
+    fields: Array<StructFieldApiName>;
 }
 /**
    * Contains the status of the submission criteria.