@osdk/foundry.ontologies 2.32.0 → 2.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/build/browser/_components.d.ts +699 -18
  3. package/build/browser/_components.d.ts.map +1 -1
  4. package/build/browser/_errors.d.ts +14 -0
  5. package/build/browser/_errors.d.ts.map +1 -1
  6. package/build/browser/index.d.ts +3 -2
  7. package/build/browser/index.d.ts.map +1 -1
  8. package/build/browser/index.js +1 -0
  9. package/build/browser/index.js.map +1 -1
  10. package/build/browser/public/ActionTypeFullMetadata.d.ts +20 -0
  11. package/build/browser/public/ActionTypeFullMetadata.d.ts.map +1 -0
  12. package/build/browser/public/ActionTypeFullMetadata.js +30 -0
  13. package/build/browser/public/ActionTypeFullMetadata.js.map +1 -0
  14. package/build/browser/public/OntologyV2.d.ts +2 -0
  15. package/build/browser/public/OntologyV2.d.ts.map +1 -1
  16. package/build/browser/public/OntologyV2.js +2 -0
  17. package/build/browser/public/OntologyV2.js.map +1 -1
  18. package/build/browser/public/OntologyValueType.d.ts +2 -2
  19. package/build/browser/public/OntologyValueType.js +2 -2
  20. package/build/browser/public/OntologyValueType.js.map +1 -1
  21. package/build/esm/_components.d.ts +699 -18
  22. package/build/esm/_components.d.ts.map +1 -1
  23. package/build/esm/_errors.d.ts +14 -0
  24. package/build/esm/_errors.d.ts.map +1 -1
  25. package/build/esm/index.d.ts +3 -2
  26. package/build/esm/index.d.ts.map +1 -1
  27. package/build/esm/index.js +1 -0
  28. package/build/esm/index.js.map +1 -1
  29. package/build/esm/public/ActionTypeFullMetadata.d.ts +20 -0
  30. package/build/esm/public/ActionTypeFullMetadata.d.ts.map +1 -0
  31. package/build/esm/public/ActionTypeFullMetadata.js +30 -0
  32. package/build/esm/public/ActionTypeFullMetadata.js.map +1 -0
  33. package/build/esm/public/OntologyV2.d.ts +2 -0
  34. package/build/esm/public/OntologyV2.d.ts.map +1 -1
  35. package/build/esm/public/OntologyV2.js +2 -0
  36. package/build/esm/public/OntologyV2.js.map +1 -1
  37. package/build/esm/public/OntologyValueType.d.ts +2 -2
  38. package/build/esm/public/OntologyValueType.js +2 -2
  39. package/build/esm/public/OntologyValueType.js.map +1 -1
  40. package/package.json +4 -4
@@ -24,6 +24,38 @@ export interface AbsoluteValuePropertyExpression {
24
24
  * Log Safety: UNSAFE
25
25
  */
26
26
  export type Action = LooselyBrandedString<"Action">;
27
+ /**
28
+ * A detailed operation for an Action
29
+ *
30
+ * Log Safety: UNSAFE
31
+ */
32
+ export type ActionLogicRule = ({
33
+ type: "modifyInterface";
34
+ } & ModifyInterfaceLogicRule) | ({
35
+ type: "createOrModifyObject";
36
+ } & CreateOrModifyObjectLogicRule) | ({
37
+ type: "modifyObject";
38
+ } & ModifyObjectLogicRule) | ({
39
+ type: "deleteLink";
40
+ } & DeleteLinkLogicRule) | ({
41
+ type: "createObject";
42
+ } & CreateObjectLogicRule) | ({
43
+ type: "createLink";
44
+ } & CreateLinkLogicRule) | ({
45
+ type: "batchedFunction";
46
+ } & BatchedFunctionLogicRule) | ({
47
+ type: "createOrModifyObjectV2";
48
+ } & CreateOrModifyObjectLogicRuleV2) | ({
49
+ type: "deleteInterfaceLink";
50
+ } & DeleteInterfaceLinkLogicRule) | ({
51
+ type: "deleteObject";
52
+ } & DeleteObjectLogicRule) | ({
53
+ type: "function";
54
+ } & FunctionLogicRule) | ({
55
+ type: "createInterfaceLink";
56
+ } & CreateInterfaceLinkLogicRule) | ({
57
+ type: "createInterface";
58
+ } & CreateInterfaceLogicRule);
27
59
  /**
28
60
  * Log Safety: SAFE
29
61
  */
@@ -124,6 +156,15 @@ endpoint or check the Ontology Manager.
124
156
  * Log Safety: UNSAFE
125
157
  */
126
158
  export type ActionTypeApiName = LooselyBrandedString<"ActionTypeApiName">;
159
+ /**
160
+ * Returns the full metadata for an Action type in the Ontology.
161
+ *
162
+ * Log Safety: UNSAFE
163
+ */
164
+ export interface ActionTypeFullMetadata {
165
+ actionType: ActionTypeV2;
166
+ fullLogicRule: ActionLogicRule;
167
+ }
127
168
  /**
128
169
  * The unique resource identifier of an action type, useful for interacting with other Foundry APIs.
129
170
  *
@@ -193,6 +234,13 @@ export interface AddObjectEdit {
193
234
  export interface AddPropertyExpression {
194
235
  properties: Array<DerivedPropertyDefinition>;
195
236
  }
237
+ /**
238
+ * Log Safety: UNSAFE
239
+ */
240
+ export interface Affix {
241
+ prefix?: PropertyTypeReferenceOrStringConstant;
242
+ postfix?: PropertyTypeReferenceOrStringConstant;
243
+ }
196
244
  /**
197
245
  * Log Safety: UNSAFE
198
246
  */
@@ -799,6 +847,13 @@ export interface BatchApplyActionResponse {
799
847
  export interface BatchApplyActionResponseV2 {
800
848
  edits?: BatchActionResults;
801
849
  }
850
+ /**
851
+ * Log Safety: UNSAFE
852
+ */
853
+ export interface BatchedFunctionLogicRule {
854
+ objectSetRidInputName: FunctionParameterName;
855
+ functionRule: FunctionLogicRule;
856
+ }
802
857
  /**
803
858
  * Log Safety: SAFE
804
859
  */
@@ -932,12 +987,38 @@ export interface CountAggregationV2 {
932
987
  export interface CountObjectsResponseV2 {
933
988
  count?: number;
934
989
  }
990
+ /**
991
+ * Log Safety: UNSAFE
992
+ */
993
+ export interface CreateInterfaceLinkLogicRule {
994
+ interfaceTypeApiName: InterfaceTypeApiName;
995
+ interfaceLinkTypeApiName: InterfaceLinkTypeApiName;
996
+ sourceObject: ParameterId;
997
+ targetObject: ParameterId;
998
+ }
999
+ /**
1000
+ * Log Safety: UNSAFE
1001
+ */
1002
+ export interface CreateInterfaceLogicRule {
1003
+ interfaceTypeApiName: InterfaceTypeApiName;
1004
+ objectType: ParameterId;
1005
+ sharedPropertyArguments: Record<SharedPropertyTypeApiName, LogicRuleArgument>;
1006
+ structPropertyArguments: Record<SharedPropertyTypeApiName, Record<StructFieldApiName, StructFieldArgument>>;
1007
+ }
935
1008
  /**
936
1009
  * Log Safety: UNSAFE
937
1010
  */
938
1011
  export interface CreateInterfaceObjectRule {
939
1012
  interfaceTypeApiName: InterfaceTypeApiName;
940
1013
  }
1014
+ /**
1015
+ * Log Safety: UNSAFE
1016
+ */
1017
+ export interface CreateLinkLogicRule {
1018
+ linkTypeApiName: LinkTypeApiName;
1019
+ sourceObject: ParameterId;
1020
+ targetObject: ParameterId;
1021
+ }
941
1022
  /**
942
1023
  * Log Safety: UNSAFE
943
1024
  */
@@ -947,12 +1028,36 @@ export interface CreateLinkRule {
947
1028
  aSideObjectTypeApiName: ObjectTypeApiName;
948
1029
  bSideObjectTypeApiName: ObjectTypeApiName;
949
1030
  }
1031
+ /**
1032
+ * Log Safety: UNSAFE
1033
+ */
1034
+ export interface CreateObjectLogicRule {
1035
+ objectTypeApiName: ObjectTypeApiName;
1036
+ propertyArguments: Record<PropertyApiName, LogicRuleArgument>;
1037
+ structPropertyArguments: Record<PropertyApiName, Record<StructFieldApiName, StructFieldArgument>>;
1038
+ }
950
1039
  /**
951
1040
  * Log Safety: UNSAFE
952
1041
  */
953
1042
  export interface CreateObjectRule {
954
1043
  objectTypeApiName: ObjectTypeApiName;
955
1044
  }
1045
+ /**
1046
+ * Log Safety: UNSAFE
1047
+ */
1048
+ export interface CreateOrModifyObjectLogicRule {
1049
+ objectTypeApiName: ObjectTypeApiName;
1050
+ propertyArguments: Record<PropertyApiName, LogicRuleArgument>;
1051
+ structPropertyArguments: Record<PropertyApiName, Record<StructFieldApiName, StructFieldArgument>>;
1052
+ }
1053
+ /**
1054
+ * Log Safety: UNSAFE
1055
+ */
1056
+ export interface CreateOrModifyObjectLogicRuleV2 {
1057
+ objectToModify: ParameterId;
1058
+ propertyArguments: Record<PropertyApiName, LogicRuleArgument>;
1059
+ structPropertyArguments: Record<PropertyApiName, Record<StructFieldApiName, StructFieldArgument>>;
1060
+ }
956
1061
  /**
957
1062
  * Log Safety: UNSAFE
958
1063
  */
@@ -965,6 +1070,20 @@ export interface CreateTemporaryObjectSetRequestV2 {
965
1070
  export interface CreateTemporaryObjectSetResponseV2 {
966
1071
  objectSetRid: ObjectSetRid;
967
1072
  }
1073
+ /**
1074
+ * Represents the current time argument in a logic rule.
1075
+ *
1076
+ * Log Safety: SAFE
1077
+ */
1078
+ export interface CurrentTimeArgument {
1079
+ }
1080
+ /**
1081
+ * Represents the current user argument in a logic rule.
1082
+ *
1083
+ * Log Safety: SAFE
1084
+ */
1085
+ export interface CurrentUserArgument {
1086
+ }
968
1087
  /**
969
1088
  * A UUID representing a custom type in a given Function.
970
1089
  *
@@ -1004,6 +1123,57 @@ export type CustomTypeId = LooselyBrandedString<"CustomTypeId">;
1004
1123
  * Log Safety: UNSAFE
1005
1124
  */
1006
1125
  export type DataValue = any;
1126
+ /**
1127
+ * Log Safety: UNSAFE
1128
+ */
1129
+ export type DatetimeFormat = ({
1130
+ type: "stringFormat";
1131
+ } & DatetimeStringFormat) | ({
1132
+ type: "localizedFormat";
1133
+ } & DatetimeLocalizedFormat);
1134
+ /**
1135
+ * Predefined localized formatting options.
1136
+ *
1137
+ * Log Safety: SAFE
1138
+ */
1139
+ export interface DatetimeLocalizedFormat {
1140
+ format: DatetimeLocalizedFormatType;
1141
+ }
1142
+ /**
1143
+ * Localized date/time format types.
1144
+ *
1145
+ * Log Safety: SAFE
1146
+ */
1147
+ export type DatetimeLocalizedFormatType = "DATE_FORMAT_RELATIVE_TO_NOW" | "DATE_FORMAT_DATE" | "DATE_FORMAT_YEAR_AND_MONTH" | "DATE_FORMAT_DATE_TIME" | "DATE_FORMAT_DATE_TIME_SHORT" | "DATE_FORMAT_TIME" | "DATE_FORMAT_ISO_INSTANT";
1148
+ /**
1149
+ * A strictly specified date format pattern.
1150
+ *
1151
+ * Log Safety: SAFE
1152
+ */
1153
+ export interface DatetimeStringFormat {
1154
+ pattern: string;
1155
+ }
1156
+ /**
1157
+ * Log Safety: UNSAFE
1158
+ */
1159
+ export type DatetimeTimezone = ({
1160
+ type: "static";
1161
+ } & DatetimeTimezoneStatic) | ({
1162
+ type: "user";
1163
+ } & DatetimeTimezoneUser);
1164
+ /**
1165
+ * Log Safety: UNSAFE
1166
+ */
1167
+ export interface DatetimeTimezoneStatic {
1168
+ zoneId: PropertyTypeReferenceOrStringConstant;
1169
+ }
1170
+ /**
1171
+ * The user's local timezone.
1172
+ *
1173
+ * Log Safety: SAFE
1174
+ */
1175
+ export interface DatetimeTimezoneUser {
1176
+ }
1007
1177
  /**
1008
1178
  * The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.
1009
1179
  *
@@ -1012,6 +1182,15 @@ export type DataValue = any;
1012
1182
  export interface DecryptionResult {
1013
1183
  plaintext?: Plaintext;
1014
1184
  }
1185
+ /**
1186
+ * Log Safety: UNSAFE
1187
+ */
1188
+ export interface DeleteInterfaceLinkLogicRule {
1189
+ interfaceTypeApiName: InterfaceTypeApiName;
1190
+ interfaceLinkTypeApiName: InterfaceLinkTypeApiName;
1191
+ sourceObject: ParameterId;
1192
+ targetObject: ParameterId;
1193
+ }
1015
1194
  /**
1016
1195
  * Log Safety: UNSAFE
1017
1196
  */
@@ -1036,6 +1215,14 @@ export interface DeleteLinkEdit {
1036
1215
  linkType: LinkTypeApiName;
1037
1216
  linkedObjectPrimaryKey: PrimaryKeyValue;
1038
1217
  }
1218
+ /**
1219
+ * Log Safety: UNSAFE
1220
+ */
1221
+ export interface DeleteLinkLogicRule {
1222
+ linkTypeApiName: LinkTypeApiName;
1223
+ sourceObject: ParameterId;
1224
+ targetObject: ParameterId;
1225
+ }
1039
1226
  /**
1040
1227
  * Log Safety: UNSAFE
1041
1228
  */
@@ -1059,6 +1246,12 @@ export interface DeleteObjectEdit {
1059
1246
  objectType: ObjectTypeApiName;
1060
1247
  primaryKey: PropertyValue;
1061
1248
  }
1249
+ /**
1250
+ * Log Safety: UNSAFE
1251
+ */
1252
+ export interface DeleteObjectLogicRule {
1253
+ objectToDelete: ParameterId;
1254
+ }
1062
1255
  /**
1063
1256
  * Log Safety: UNSAFE
1064
1257
  */
@@ -1167,6 +1360,26 @@ export interface DoubleVector {
1167
1360
  * Log Safety: UNSAFE
1168
1361
  */
1169
1362
  export type Duration = LooselyBrandedString<"Duration">;
1363
+ /**
1364
+ * Specifies the unit of the input duration value.
1365
+ *
1366
+ * Log Safety: SAFE
1367
+ */
1368
+ export type DurationBaseValue = "SECONDS" | "MILLISECONDS";
1369
+ /**
1370
+ * Log Safety: UNSAFE
1371
+ */
1372
+ export type DurationFormatStyle = ({
1373
+ type: "humanReadable";
1374
+ } & HumanReadableFormat) | ({
1375
+ type: "timecode";
1376
+ } & TimeCodeFormat);
1377
+ /**
1378
+ * Specifies the maximum precision to apply when formatting a duration.
1379
+ *
1380
+ * Log Safety: SAFE
1381
+ */
1382
+ export type DurationPrecision = "DAYS" | "HOURS" | "MINUTES" | "SECONDS" | "AUTO";
1170
1383
  /**
1171
1384
  * Log Safety: UNSAFE
1172
1385
  */
@@ -1274,6 +1487,26 @@ properties.{propertyApiName}.isNull=false.
1274
1487
  * Log Safety: UNSAFE
1275
1488
  */
1276
1489
  export type FilterValue = LooselyBrandedString<"FilterValue">;
1490
+ /**
1491
+ * Integer key for fixed value mapping.
1492
+ *
1493
+ * Log Safety: SAFE
1494
+ */
1495
+ export type FixedValuesMapKey = number;
1496
+ /**
1497
+ * Log Safety: UNSAFE
1498
+ */
1499
+ export interface FunctionLogicRule {
1500
+ functionRid: FunctionRid;
1501
+ functionVersion: FunctionVersion;
1502
+ functionInputValues: Record<FunctionParameterName, LogicRuleArgument>;
1503
+ }
1504
+ /**
1505
+ * The name of an input to a function.
1506
+ *
1507
+ * Log Safety: UNSAFE
1508
+ */
1509
+ export type FunctionParameterName = LooselyBrandedString<"FunctionParameterName">;
1277
1510
  /**
1278
1511
  * The unique resource identifier of a Function, useful for interacting with other Foundry APIs.
1279
1512
  *
@@ -1394,6 +1627,14 @@ export interface GtQueryV2 {
1394
1627
  propertyIdentifier?: PropertyIdentifier;
1395
1628
  value: PropertyValue;
1396
1629
  }
1630
+ /**
1631
+ * Formats the duration as a human-readable written string.
1632
+ *
1633
+ * Log Safety: SAFE
1634
+ */
1635
+ export interface HumanReadableFormat {
1636
+ showFullUnits?: boolean;
1637
+ }
1397
1638
  /**
1398
1639
  * A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).
1399
1640
  *
@@ -1459,6 +1700,15 @@ export type InterfaceLinkTypeLinkedEntityApiName = ({
1459
1700
  * Log Safety: SAFE
1460
1701
  */
1461
1702
  export type InterfaceLinkTypeRid = LooselyBrandedString<"InterfaceLinkTypeRid">;
1703
+ /**
1704
+ * Represents an interface parameter property argument in a logic rule.
1705
+ *
1706
+ * Log Safety: UNSAFE
1707
+ */
1708
+ export interface InterfaceParameterPropertyArgument {
1709
+ parameterId: ParameterId;
1710
+ sharedPropertyTypeRid: string;
1711
+ }
1462
1712
  /**
1463
1713
  * A shared property type with an additional field to indicate whether the property must be included on every
1464
1714
  object type that implements the interface, or whether it is optional.
@@ -1559,6 +1809,16 @@ export interface IsNullQueryV2 {
1559
1809
  propertyIdentifier?: PropertyIdentifier;
1560
1810
  value: boolean;
1561
1811
  }
1812
+ /**
1813
+ * Known Foundry types for specialized formatting:
1814
+
1815
+ userOrGroupRid: Format as user or group RID (both are structurally RIDs)
1816
+ resourceRid: Format as resource RID
1817
+ artifactGid: Format as artifact GID
1818
+ *
1819
+ * Log Safety: SAFE
1820
+ */
1821
+ export type KnownType = "userOrGroupRid" | "resourceRid" | "artifactGid";
1562
1822
  /**
1563
1823
  * Finds least of two or more numeric, date or timestamp values.
1564
1824
  *
@@ -1918,6 +2178,28 @@ export type LogicRule = ({
1918
2178
  } & CreateObjectRule) | ({
1919
2179
  type: "createLink";
1920
2180
  } & CreateLinkRule);
2181
+ /**
2182
+ * 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.
2183
+ *
2184
+ * Log Safety: UNSAFE
2185
+ */
2186
+ export type LogicRuleArgument = ({
2187
+ type: "currentTime";
2188
+ } & CurrentTimeArgument) | ({
2189
+ type: "staticValue";
2190
+ } & StaticArgument) | ({
2191
+ type: "currentUser";
2192
+ } & CurrentUserArgument) | ({
2193
+ type: "parameterId";
2194
+ } & ParameterIdArgument) | ({
2195
+ type: "interfaceParameterPropertyValue";
2196
+ } & InterfaceParameterPropertyArgument) | ({
2197
+ type: "synchronousWebhookOutput";
2198
+ } & SynchronousWebhookOutputArgument) | ({
2199
+ type: "objectParameterPropertyValue";
2200
+ } & ObjectParameterPropertyArgument) | ({
2201
+ type: "uniqueIdentifier";
2202
+ } & UniqueIdentifierArgument);
1921
2203
  /**
1922
2204
  * Returns objects where the specified field is less than or equal to a value.
1923
2205
  *
@@ -2012,6 +2294,14 @@ export interface MinAggregationV2 {
2012
2294
  name?: AggregationMetricName;
2013
2295
  direction?: OrderByDirection;
2014
2296
  }
2297
+ /**
2298
+ * Log Safety: UNSAFE
2299
+ */
2300
+ export interface ModifyInterfaceLogicRule {
2301
+ interfaceObjectToModify: ParameterId;
2302
+ sharedPropertyArguments: Record<SharedPropertyTypeApiName, LogicRuleArgument>;
2303
+ structPropertyArguments: Record<SharedPropertyTypeApiName, Record<StructFieldApiName, StructFieldArgument>>;
2304
+ }
2015
2305
  /**
2016
2306
  * Log Safety: UNSAFE
2017
2307
  */
@@ -2033,6 +2323,14 @@ export interface ModifyObjectEdit {
2033
2323
  primaryKey: PropertyValue;
2034
2324
  properties: Record<PropertyApiName, DataValue>;
2035
2325
  }
2326
+ /**
2327
+ * Log Safety: UNSAFE
2328
+ */
2329
+ export interface ModifyObjectLogicRule {
2330
+ objectToModify: ParameterId;
2331
+ propertyArguments: Record<PropertyApiName, LogicRuleArgument>;
2332
+ structPropertyArguments: Record<PropertyApiName, Record<StructFieldApiName, StructFieldArgument>>;
2333
+ }
2036
2334
  /**
2037
2335
  * Log Safety: UNSAFE
2038
2336
  */
@@ -2097,6 +2395,188 @@ export interface NotQuery {
2097
2395
  export interface NotQueryV2 {
2098
2396
  value: SearchJsonQueryV2;
2099
2397
  }
2398
+ /**
2399
+ * Attach arbitrary text before and/or after the formatted number.
2400
+ Example: prefix "USD " and postfix " total" displays as "USD 1,234.56 total"
2401
+ *
2402
+ * Log Safety: UNSAFE
2403
+ */
2404
+ export interface NumberFormatAffix {
2405
+ baseFormatOptions: NumberFormatOptions;
2406
+ affix: Affix;
2407
+ }
2408
+ /**
2409
+ * Display the value as basis points. Multiplies by 10,000 and appends "bps" suffix.
2410
+ Used in finance where 1 basis point = 0.01%.
2411
+ Example: 0.0025 displays as "25 bps", 0.01 displays as "100 bps"
2412
+ *
2413
+ * Log Safety: SAFE
2414
+ */
2415
+ export interface NumberFormatBasisPoints {
2416
+ baseFormatOptions: NumberFormatOptions;
2417
+ }
2418
+ /**
2419
+ * Format numbers as currency values with proper symbols and styling.
2420
+ Example: 1234.56 with currency "USD" displays as "USD 1,234.56" (standard) or "USD 1.2K" (compact)
2421
+ *
2422
+ * Log Safety: UNSAFE
2423
+ */
2424
+ export interface NumberFormatCurrency {
2425
+ baseFormatOptions: NumberFormatOptions;
2426
+ style: NumberFormatCurrencyStyle;
2427
+ currencyCode: PropertyTypeReferenceOrStringConstant;
2428
+ }
2429
+ /**
2430
+ * Currency rendering style options:
2431
+
2432
+ STANDARD: Full currency formatting (e.g., "USD 1,234.56")
2433
+ COMPACT: Abbreviated currency formatting (e.g., "USD 1.2K")
2434
+ *
2435
+ * Log Safety: SAFE
2436
+ */
2437
+ export type NumberFormatCurrencyStyle = "STANDARD" | "COMPACT";
2438
+ /**
2439
+ * Format numbers with custom units not supported by standard formatting.
2440
+ Use this for domain-specific units like "requests/sec", "widgets", etc.
2441
+ Example: 1500 with unit "widgets" displays as "1,500 widgets"
2442
+ *
2443
+ * Log Safety: UNSAFE
2444
+ */
2445
+ export interface NumberFormatCustomUnit {
2446
+ baseFormatOptions: NumberFormatOptions;
2447
+ unit: PropertyTypeReferenceOrStringConstant;
2448
+ }
2449
+ /**
2450
+ * Format numeric values representing time durations.
2451
+
2452
+ Human readable: 3661 seconds displays as "1h 1m 1s"
2453
+ Timecode: 3661 seconds displays as "01:01:01"
2454
+ *
2455
+ * Log Safety: UNSAFE
2456
+ */
2457
+ export interface NumberFormatDuration {
2458
+ formatStyle: DurationFormatStyle;
2459
+ precision?: DurationPrecision;
2460
+ baseValue: DurationBaseValue;
2461
+ }
2462
+ /**
2463
+ * Map integer values to custom human-readable strings.
2464
+ Example: {1: "First", 2: "Second", 3: "Third"} would display 2 as "Second".
2465
+ *
2466
+ * Log Safety: UNSAFE
2467
+ */
2468
+ export interface NumberFormatFixedValues {
2469
+ values: Record<FixedValuesMapKey, string>;
2470
+ }
2471
+ /**
2472
+ * Number notation style options:
2473
+
2474
+ STANDARD: Regular number display ("1,234")
2475
+ SCIENTIFIC: Scientific notation ("1.234E3")
2476
+ ENGINEERING: Engineering notation ("1.234E3")
2477
+ COMPACT: Compact notation ("1.2K")
2478
+ *
2479
+ * Log Safety: SAFE
2480
+ */
2481
+ export type NumberFormatNotation = "STANDARD" | "SCIENTIFIC" | "ENGINEERING" | "COMPACT";
2482
+ /**
2483
+ * Base number formatting options that can be applied to all number formatters.
2484
+ Controls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat.
2485
+ Examples:
2486
+
2487
+ useGrouping: true makes 1234567 display as "1,234,567"
2488
+ maximumFractionDigits: 2 makes 3.14159 display as "3.14"
2489
+ notation: SCIENTIFIC makes 1234 display as "1.234E3"
2490
+ *
2491
+ * Log Safety: SAFE
2492
+ */
2493
+ export interface NumberFormatOptions {
2494
+ useGrouping?: boolean;
2495
+ convertNegativeToParenthesis?: boolean;
2496
+ minimumIntegerDigits?: number;
2497
+ minimumFractionDigits?: number;
2498
+ maximumFractionDigits?: number;
2499
+ minimumSignificantDigits?: number;
2500
+ maximumSignificantDigits?: number;
2501
+ notation?: NumberFormatNotation;
2502
+ roundingMode?: NumberRoundingMode;
2503
+ }
2504
+ /**
2505
+ * Display the value as a ratio with different scaling factors and suffixes:
2506
+
2507
+ PERCENTAGE: Multiply by 100 and add "%" suffix (0.15 → "15%")
2508
+ PER_MILLE: Multiply by 1000 and add "‰" suffix (0.015 → "15‰")
2509
+ BASIS_POINTS: Multiply by 10000 and add "bps" suffix (0.0015 → "15bps")
2510
+ *
2511
+ * Log Safety: SAFE
2512
+ */
2513
+ export interface NumberFormatRatio {
2514
+ ratioType: NumberRatioType;
2515
+ baseFormatOptions: NumberFormatOptions;
2516
+ }
2517
+ /**
2518
+ * Scale the numeric value by dividing by the specified factor and append an appropriate suffix.
2519
+
2520
+ THOUSANDS: 1500 displays as "1.5K"
2521
+ MILLIONS: 2500000 displays as "2.5M"
2522
+ BILLIONS: 3200000000 displays as "3.2B"
2523
+ *
2524
+ * Log Safety: SAFE
2525
+ */
2526
+ export interface NumberFormatScale {
2527
+ scaleType: NumberScaleType;
2528
+ baseFormatOptions: NumberFormatOptions;
2529
+ }
2530
+ /**
2531
+ * Standard number formatting with configurable options.
2532
+ This provides basic number formatting without any special units, scaling, or transformations.
2533
+ *
2534
+ * Log Safety: SAFE
2535
+ */
2536
+ export interface NumberFormatStandard {
2537
+ baseFormatOptions: NumberFormatOptions;
2538
+ }
2539
+ /**
2540
+ * Format numbers with standard units supported by Intl.NumberFormat.
2541
+ Examples: "meter", "kilogram", "celsius", "percent"
2542
+ Input: 25 with unit "celsius" displays as "25 degrees C"
2543
+ *
2544
+ * Log Safety: UNSAFE
2545
+ */
2546
+ export interface NumberFormatStandardUnit {
2547
+ baseFormatOptions: NumberFormatOptions;
2548
+ unit: PropertyTypeReferenceOrStringConstant;
2549
+ }
2550
+ /**
2551
+ * Ratio format options for displaying proportional values:
2552
+
2553
+ PERCENTAGE: Multiply by 100 and add "%" suffix
2554
+ PER_MILLE: Multiply by 1000 and add "‰" suffix
2555
+ BASIS_POINTS: Multiply by 10000 and add "bps" suffix
2556
+ *
2557
+ * Log Safety: SAFE
2558
+ */
2559
+ export type NumberRatioType = "PERCENTAGE" | "PER_MILLE" | "BASIS_POINTS";
2560
+ /**
2561
+ * Number rounding behavior:
2562
+
2563
+ CEIL: Always round up (3.1 becomes 4)
2564
+ FLOOR: Always round down (3.9 becomes 3)
2565
+ ROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4)
2566
+ *
2567
+ * Log Safety: SAFE
2568
+ */
2569
+ export type NumberRoundingMode = "CEIL" | "FLOOR" | "ROUND_CLOSEST";
2570
+ /**
2571
+ * Scale factor options for large numbers:
2572
+
2573
+ THOUSANDS: Divide by 1,000 and add "K" suffix
2574
+ MILLIONS: Divide by 1,000,000 and add "M" suffix
2575
+ BILLIONS: Divide by 1,000,000,000 and add "B" suffix
2576
+ *
2577
+ * Log Safety: SAFE
2578
+ */
2579
+ export type NumberScaleType = "THOUSANDS" | "MILLIONS" | "BILLIONS";
2100
2580
  /**
2101
2581
  * Log Safety: UNSAFE
2102
2582
  */
@@ -2131,6 +2611,15 @@ export interface ObjectLocator {
2131
2611
  objectTypeApiName: ObjectTypeApiName;
2132
2612
  primaryKeyValue: PrimaryKeyValue;
2133
2613
  }
2614
+ /**
2615
+ * Represents an object parameter property argument in a logic rule.
2616
+ *
2617
+ * Log Safety: UNSAFE
2618
+ */
2619
+ export interface ObjectParameterPropertyArgument {
2620
+ parameterId: ParameterId;
2621
+ propertyTypeApiName: PropertyTypeApiName;
2622
+ }
2134
2623
  /**
2135
2624
  * Log Safety: UNSAFE
2136
2625
  */
@@ -2319,6 +2808,7 @@ export interface ObjectSetNearestNeighborsType {
2319
2808
  objectSet: ObjectSet;
2320
2809
  propertyIdentifier: PropertyIdentifier;
2321
2810
  numNeighbors: number;
2811
+ similarityThreshold?: number;
2322
2812
  query: NearestNeighborsQuery;
2323
2813
  }
2324
2814
  /**
@@ -2848,6 +3338,14 @@ Parameters can be viewed and managed in the Ontology Manager.
2848
3338
  * Log Safety: UNSAFE
2849
3339
  */
2850
3340
  export type ParameterId = LooselyBrandedString<"ParameterId">;
3341
+ /**
3342
+ * Represents a parameter ID argument in a logic rule.
3343
+ *
3344
+ * Log Safety: UNSAFE
3345
+ */
3346
+ export interface ParameterIdArgument {
3347
+ parameterId: ParameterId;
3348
+ }
2851
3349
  /**
2852
3350
  * A possible value for the parameter. This is defined in the Ontology Manager by Actions admins.
2853
3351
  *
@@ -2945,6 +3443,23 @@ export type PropertyApiName = LooselyBrandedString<"PropertyApiName">;
2945
3443
  export interface PropertyApiNameSelector {
2946
3444
  apiName: PropertyApiName;
2947
3445
  }
3446
+ /**
3447
+ * Formatting configuration for boolean property values.
3448
+ *
3449
+ * Log Safety: UNSAFE
3450
+ */
3451
+ export interface PropertyBooleanFormattingRule {
3452
+ valueIfTrue: string;
3453
+ valueIfFalse: string;
3454
+ }
3455
+ /**
3456
+ * Formatting configuration for date property values.
3457
+ *
3458
+ * Log Safety: UNSAFE
3459
+ */
3460
+ export interface PropertyDateFormattingRule {
3461
+ format: DatetimeFormat;
3462
+ }
2948
3463
  /**
2949
3464
  * Represents a filter used on properties.
2950
3465
  Endpoints that accept this supports optional parameters that have the form:
@@ -2990,10 +3505,71 @@ export type PropertyIdentifier = ({
2990
3505
  } & PropertyApiNameSelector) | ({
2991
3506
  type: "structField";
2992
3507
  } & StructFieldSelector);
3508
+ /**
3509
+ * Formatting configuration for known Foundry types.
3510
+ *
3511
+ * Log Safety: SAFE
3512
+ */
3513
+ export interface PropertyKnownTypeFormattingRule {
3514
+ knownType: KnownType;
3515
+ }
3516
+ /**
3517
+ * Wrapper for numeric formatting options.
3518
+ *
3519
+ * Log Safety: UNSAFE
3520
+ */
3521
+ export interface PropertyNumberFormattingRule {
3522
+ numberType: PropertyNumberFormattingRuleType;
3523
+ }
3524
+ /**
3525
+ * Log Safety: UNSAFE
3526
+ */
3527
+ export type PropertyNumberFormattingRuleType = ({
3528
+ type: "standard";
3529
+ } & NumberFormatStandard) | ({
3530
+ type: "duration";
3531
+ } & NumberFormatDuration) | ({
3532
+ type: "fixedValues";
3533
+ } & NumberFormatFixedValues) | ({
3534
+ type: "affix";
3535
+ } & NumberFormatAffix) | ({
3536
+ type: "scale";
3537
+ } & NumberFormatScale) | ({
3538
+ type: "currency";
3539
+ } & NumberFormatCurrency) | ({
3540
+ type: "standardUnit";
3541
+ } & NumberFormatStandardUnit) | ({
3542
+ type: "customUnit";
3543
+ } & NumberFormatCustomUnit) | ({
3544
+ type: "ratio";
3545
+ } & NumberFormatRatio);
3546
+ /**
3547
+ * Formatting configuration for timestamp property values.
3548
+ *
3549
+ * Log Safety: UNSAFE
3550
+ */
3551
+ export interface PropertyTimestampFormattingRule {
3552
+ format: DatetimeFormat;
3553
+ displayTimezone: DatetimeTimezone;
3554
+ }
2993
3555
  /**
2994
3556
  * Log Safety: UNSAFE
2995
3557
  */
2996
3558
  export type PropertyTypeApiName = LooselyBrandedString<"PropertyTypeApiName">;
3559
+ /**
3560
+ * Log Safety: UNSAFE
3561
+ */
3562
+ export interface PropertyTypeReference {
3563
+ propertyApiName: string;
3564
+ }
3565
+ /**
3566
+ * Log Safety: UNSAFE
3567
+ */
3568
+ export type PropertyTypeReferenceOrStringConstant = ({
3569
+ type: "constant";
3570
+ } & StringConstant) | ({
3571
+ type: "propertyType";
3572
+ } & PropertyTypeReference);
2997
3573
  /**
2998
3574
  * Log Safety: SAFE
2999
3575
  */
@@ -3029,6 +3605,7 @@ export interface PropertyV2 {
3029
3605
  status?: PropertyTypeStatus;
3030
3606
  visibility?: PropertyTypeVisibility;
3031
3607
  valueTypeApiName?: ValueTypeApiName;
3608
+ valueFormatting?: PropertyValueFormattingRule;
3032
3609
  }
3033
3610
  /**
3034
3611
  * Represents the value of a property in the following format.
@@ -3066,6 +3643,30 @@ export type PropertyValue = any;
3066
3643
  * Log Safety: UNSAFE
3067
3644
  */
3068
3645
  export type PropertyValueEscapedString = LooselyBrandedString<"PropertyValueEscapedString">;
3646
+ /**
3647
+ * This feature is experimental and may change in a future release.
3648
+ Comprehensive formatting configuration for displaying property values in user interfaces.
3649
+ Supports different value types including numbers, dates, timestamps, booleans, and known Foundry types.
3650
+ Each formatter type provides specific options tailored to that data type:
3651
+
3652
+ Numbers: Support for percentages, currencies, units, scaling, and custom formatting
3653
+ Dates/Timestamps: Localized and custom formatting patterns
3654
+ Booleans: Custom true/false display text
3655
+ Known types: Special formatting for Foundry-specific identifiers
3656
+ *
3657
+ * Log Safety: UNSAFE
3658
+ */
3659
+ export type PropertyValueFormattingRule = ({
3660
+ type: "date";
3661
+ } & PropertyDateFormattingRule) | ({
3662
+ type: "number";
3663
+ } & PropertyNumberFormattingRule) | ({
3664
+ type: "boolean";
3665
+ } & PropertyBooleanFormattingRule) | ({
3666
+ type: "knownType";
3667
+ } & PropertyKnownTypeFormattingRule) | ({
3668
+ type: "timestamp";
3669
+ } & PropertyTimestampFormattingRule);
3069
3670
  /**
3070
3671
  * An error indicating that the subscribe request should be attempted on a different node.
3071
3672
  *
@@ -3370,6 +3971,18 @@ export interface RegexConstraint {
3370
3971
  pattern: string;
3371
3972
  partialMatch: boolean;
3372
3973
  }
3974
+ /**
3975
+ * Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed
3976
+ form of text fields and supports standard regex syntax of dot (.), star(*) and question mark(?).
3977
+ Either field or propertyIdentifier can be supplied, but not both.
3978
+ *
3979
+ * Log Safety: UNSAFE
3980
+ */
3981
+ export interface RegexQuery {
3982
+ field?: PropertyApiName;
3983
+ propertyIdentifier?: PropertyIdentifier;
3984
+ value: string;
3985
+ }
3373
3986
  /**
3374
3987
  * A relative time, such as "3 days before" or "2 hours after" the current moment.
3375
3988
  *
@@ -3470,42 +4083,24 @@ export type SearchJsonQuery = ({
3470
4083
  * Log Safety: UNSAFE
3471
4084
  */
3472
4085
  export type SearchJsonQueryV2 = ({
3473
- type: "or";
3474
- } & OrQueryV2) | ({
3475
- type: "in";
3476
- } & InQuery) | ({
3477
- type: "doesNotIntersectPolygon";
3478
- } & DoesNotIntersectPolygonQuery) | ({
3479
4086
  type: "lt";
3480
4087
  } & LtQueryV2) | ({
3481
4088
  type: "doesNotIntersectBoundingBox";
3482
4089
  } & DoesNotIntersectBoundingBoxQuery) | ({
3483
- type: "eq";
3484
- } & EqualsQueryV2) | ({
3485
- type: "containsAllTerms";
3486
- } & ContainsAllTermsQuery) | ({
3487
- type: "gt";
3488
- } & GtQueryV2) | ({
3489
4090
  type: "wildcard";
3490
4091
  } & WildcardQuery) | ({
3491
4092
  type: "withinDistanceOf";
3492
4093
  } & WithinDistanceOfQuery) | ({
3493
4094
  type: "withinBoundingBox";
3494
4095
  } & WithinBoundingBoxQuery) | ({
3495
- type: "contains";
3496
- } & ContainsQueryV2) | ({
3497
4096
  type: "not";
3498
4097
  } & NotQueryV2) | ({
3499
4098
  type: "intersectsBoundingBox";
3500
4099
  } & IntersectsBoundingBoxQuery) | ({
3501
4100
  type: "and";
3502
4101
  } & AndQueryV2) | ({
3503
- type: "isNull";
3504
- } & IsNullQueryV2) | ({
3505
4102
  type: "containsAllTermsInOrderPrefixLastTerm";
3506
4103
  } & ContainsAllTermsInOrderPrefixLastTerm) | ({
3507
- type: "containsAnyTerm";
3508
- } & ContainsAnyTermQuery) | ({
3509
4104
  type: "gte";
3510
4105
  } & GteQueryV2) | ({
3511
4106
  type: "containsAllTermsInOrder";
@@ -3516,6 +4111,26 @@ export type SearchJsonQueryV2 = ({
3516
4111
  } & IntersectsPolygonQuery) | ({
3517
4112
  type: "lte";
3518
4113
  } & LteQueryV2) | ({
4114
+ type: "or";
4115
+ } & OrQueryV2) | ({
4116
+ type: "in";
4117
+ } & InQuery) | ({
4118
+ type: "doesNotIntersectPolygon";
4119
+ } & DoesNotIntersectPolygonQuery) | ({
4120
+ type: "eq";
4121
+ } & EqualsQueryV2) | ({
4122
+ type: "containsAllTerms";
4123
+ } & ContainsAllTermsQuery) | ({
4124
+ type: "gt";
4125
+ } & GtQueryV2) | ({
4126
+ type: "contains";
4127
+ } & ContainsQueryV2) | ({
4128
+ type: "regex";
4129
+ } & RegexQuery) | ({
4130
+ type: "isNull";
4131
+ } & IsNullQueryV2) | ({
4132
+ type: "containsAnyTerm";
4133
+ } & ContainsAnyTermQuery) | ({
3519
4134
  type: "startsWith";
3520
4135
  } & StartsWithQuery);
3521
4136
  /**
@@ -3772,6 +4387,7 @@ export interface SharedPropertyType {
3772
4387
  description?: string;
3773
4388
  dataType: ObjectPropertyType;
3774
4389
  valueTypeApiName?: ValueTypeApiName;
4390
+ valueFormatting?: PropertyValueFormattingRule;
3775
4391
  }
3776
4392
  /**
3777
4393
  * The name of the shared property type in the API in lowerCamelCase format. To find the API name for your
@@ -3798,6 +4414,14 @@ export interface StartsWithQuery {
3798
4414
  propertyIdentifier?: PropertyIdentifier;
3799
4415
  value: string;
3800
4416
  }
4417
+ /**
4418
+ * Represents a static argument in a logic rule.
4419
+ *
4420
+ * Log Safety: UNSAFE
4421
+ */
4422
+ export interface StaticArgument {
4423
+ value: DataValue;
4424
+ }
3801
4425
  /**
3802
4426
  * Which format to serialize the binary stream in.
3803
4427
  ARROW is more efficient for streaming a large sized response.
@@ -3842,6 +4466,12 @@ export interface StreamTimeSeriesValuesRequest {
3842
4466
  export interface StreamTimeSeriesValuesResponse {
3843
4467
  data: Array<TimeseriesEntry>;
3844
4468
  }
4469
+ /**
4470
+ * Log Safety: UNSAFE
4471
+ */
4472
+ export interface StringConstant {
4473
+ value: string;
4474
+ }
3845
4475
  /**
3846
4476
  * The parameter value must have a length within the defined range.
3847
4477
  This range is always inclusive.
@@ -3883,6 +4513,16 @@ export interface StructEvaluatedConstraint {
3883
4513
  * Log Safety: UNSAFE
3884
4514
  */
3885
4515
  export type StructFieldApiName = LooselyBrandedString<"StructFieldApiName">;
4516
+ /**
4517
+ * Represents an argument used for an individual struct field.
4518
+ *
4519
+ * Log Safety: UNSAFE
4520
+ */
4521
+ export type StructFieldArgument = ({
4522
+ type: "structListParameterFieldValue";
4523
+ } & StructListParameterFieldArgument) | ({
4524
+ type: "structParameterFieldValue";
4525
+ } & StructParameterFieldArgument);
3886
4526
  /**
3887
4527
  * A constraint that an action struct parameter field value must satisfy in order to be considered valid.
3888
4528
  Constraints can be configured on fields of struct parameters in the Ontology Manager.
@@ -3943,12 +4583,30 @@ export interface StructFieldType {
3943
4583
  * Log Safety: SAFE
3944
4584
  */
3945
4585
  export type StructFieldTypeRid = LooselyBrandedString<"StructFieldTypeRid">;
4586
+ /**
4587
+ * Represents a struct list parameter field argument in a logic rule.
4588
+ *
4589
+ * Log Safety: UNSAFE
4590
+ */
4591
+ export interface StructListParameterFieldArgument {
4592
+ parameterId: ParameterId;
4593
+ structParameterFieldApiName: StructParameterFieldApiName;
4594
+ }
3946
4595
  /**
3947
4596
  * The unique identifier of the struct parameter field.
3948
4597
  *
3949
4598
  * Log Safety: UNSAFE
3950
4599
  */
3951
4600
  export type StructParameterFieldApiName = LooselyBrandedString<"StructParameterFieldApiName">;
4601
+ /**
4602
+ * Represents a struct parameter field argument in a logic rule.
4603
+ *
4604
+ * Log Safety: UNSAFE
4605
+ */
4606
+ export interface StructParameterFieldArgument {
4607
+ parameterId: ParameterId;
4608
+ structParameterFieldApiName: StructParameterFieldApiName;
4609
+ }
3952
4610
  /**
3953
4611
  * Log Safety: UNSAFE
3954
4612
  */
@@ -4036,6 +4694,14 @@ export interface SyncApplyActionResponseV2 {
4036
4694
  validation?: ValidateActionResponseV2;
4037
4695
  edits?: ActionResults;
4038
4696
  }
4697
+ /**
4698
+ * Represents a synchronous webhook output argument in a logic rule.
4699
+ *
4700
+ * Log Safety: UNSAFE
4701
+ */
4702
+ export interface SynchronousWebhookOutputArgument {
4703
+ webhookOutputParamName: string;
4704
+ }
4039
4705
  /**
4040
4706
  * Log Safety: UNSAFE
4041
4707
  */
@@ -4043,6 +4709,13 @@ export interface ThreeDimensionalAggregation {
4043
4709
  keyType: QueryAggregationKeyType;
4044
4710
  valueType: TwoDimensionalAggregation;
4045
4711
  }
4712
+ /**
4713
+ * Formats the duration in a timecode format.
4714
+ *
4715
+ * Log Safety: SAFE
4716
+ */
4717
+ export interface TimeCodeFormat {
4718
+ }
4046
4719
  /**
4047
4720
  * An absolute or relative range for a time series query.
4048
4721
  *
@@ -4199,6 +4872,14 @@ This can happen when a parameter's allowed values are defined by another paramet
4199
4872
  */
4200
4873
  export interface UnevaluableConstraint {
4201
4874
  }
4875
+ /**
4876
+ * Represents a unique identifier argument in a logic rule.
4877
+ *
4878
+ * Log Safety: SAFE
4879
+ */
4880
+ export interface UniqueIdentifierArgument {
4881
+ linkId?: string;
4882
+ }
4202
4883
  /**
4203
4884
  * The string must be a valid UUID (Universally Unique Identifier).
4204
4885
  *