@osdk/foundry.ontologies 2.46.0 → 2.47.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 (42) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/build/browser/_components.d.ts +184 -0
  3. package/build/browser/_components.d.ts.map +1 -1
  4. package/build/browser/_errors.d.ts +13 -0
  5. package/build/browser/_errors.d.ts.map +1 -1
  6. package/build/browser/index.d.ts +2 -2
  7. package/build/browser/index.d.ts.map +1 -1
  8. package/build/browser/public/Action.d.ts +2 -0
  9. package/build/browser/public/Action.d.ts.map +1 -1
  10. package/build/browser/public/ActionTypeFullMetadata.d.ts +2 -1
  11. package/build/browser/public/ActionTypeFullMetadata.d.ts.map +1 -1
  12. package/build/browser/public/GeotemporalSeriesProperty.d.ts +19 -0
  13. package/build/browser/public/GeotemporalSeriesProperty.d.ts.map +1 -1
  14. package/build/browser/public/GeotemporalSeriesProperty.js +12 -0
  15. package/build/browser/public/GeotemporalSeriesProperty.js.map +1 -1
  16. package/build/browser/public/ObjectTypeV2.d.ts +23 -0
  17. package/build/browser/public/ObjectTypeV2.d.ts.map +1 -1
  18. package/build/browser/public/ObjectTypeV2.js +19 -0
  19. package/build/browser/public/ObjectTypeV2.js.map +1 -1
  20. package/build/browser/public/OntologyTransaction.d.ts +2 -0
  21. package/build/browser/public/OntologyTransaction.d.ts.map +1 -1
  22. package/build/esm/_components.d.ts +184 -0
  23. package/build/esm/_components.d.ts.map +1 -1
  24. package/build/esm/_errors.d.ts +13 -0
  25. package/build/esm/_errors.d.ts.map +1 -1
  26. package/build/esm/index.d.ts +2 -2
  27. package/build/esm/index.d.ts.map +1 -1
  28. package/build/esm/public/Action.d.ts +2 -0
  29. package/build/esm/public/Action.d.ts.map +1 -1
  30. package/build/esm/public/ActionTypeFullMetadata.d.ts +2 -1
  31. package/build/esm/public/ActionTypeFullMetadata.d.ts.map +1 -1
  32. package/build/esm/public/GeotemporalSeriesProperty.d.ts +19 -0
  33. package/build/esm/public/GeotemporalSeriesProperty.d.ts.map +1 -1
  34. package/build/esm/public/GeotemporalSeriesProperty.js +12 -0
  35. package/build/esm/public/GeotemporalSeriesProperty.js.map +1 -1
  36. package/build/esm/public/ObjectTypeV2.d.ts +23 -0
  37. package/build/esm/public/ObjectTypeV2.d.ts.map +1 -1
  38. package/build/esm/public/ObjectTypeV2.js +19 -0
  39. package/build/esm/public/ObjectTypeV2.js.map +1 -1
  40. package/build/esm/public/OntologyTransaction.d.ts +2 -0
  41. package/build/esm/public/OntologyTransaction.d.ts.map +1 -1
  42. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @osdk/foundry.ontologies
2
2
 
3
+ ## 2.47.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 0a561e6: Fix cyclic dependency
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [0a561e6]
12
+ - @osdk/foundry.core@2.47.0
13
+ - @osdk/foundry.geo@2.47.0
14
+
3
15
  ## 2.46.0
4
16
 
5
17
  ### Minor Changes
@@ -126,6 +126,7 @@ export interface ActionParameterV2 {
126
126
  description?: string;
127
127
  dataType: ActionParameterType;
128
128
  required: boolean;
129
+ typeClasses: Array<TypeClass>;
129
130
  }
130
131
  /**
131
132
  * Log Safety: UNSAFE
@@ -921,6 +922,12 @@ export interface BlueprintIcon {
921
922
  color: string;
922
923
  name: string;
923
924
  }
925
+ /**
926
+ * Log Safety: UNSAFE
927
+ */
928
+ export interface BooleanValue {
929
+ value: boolean;
930
+ }
924
931
  /**
925
932
  * The top left and bottom right coordinate points that make up the bounding box.
926
933
  *
@@ -1073,6 +1080,12 @@ export interface CountAggregationV2 {
1073
1080
  export interface CountObjectsResponseV2 {
1074
1081
  count?: number;
1075
1082
  }
1083
+ /**
1084
+ * Log Safety: UNSAFE
1085
+ */
1086
+ export interface CreateEdit {
1087
+ properties: Record<PropertyApiName, PropertyValue>;
1088
+ }
1076
1089
  /**
1077
1090
  * Log Safety: UNSAFE
1078
1091
  */
@@ -1260,6 +1273,12 @@ export interface DatetimeTimezoneStatic {
1260
1273
  */
1261
1274
  export interface DatetimeTimezoneUser {
1262
1275
  }
1276
+ /**
1277
+ * Log Safety: UNSAFE
1278
+ */
1279
+ export interface DateValue {
1280
+ value: string;
1281
+ }
1263
1282
  /**
1264
1283
  * The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.
1265
1284
  *
@@ -1268,6 +1287,12 @@ export interface DatetimeTimezoneUser {
1268
1287
  export interface DecryptionResult {
1269
1288
  plaintext?: Plaintext;
1270
1289
  }
1290
+ /**
1291
+ * Log Safety: UNSAFE
1292
+ */
1293
+ export interface DeleteEdit {
1294
+ previousProperties: Record<PropertyApiName, PropertyValue>;
1295
+ }
1271
1296
  /**
1272
1297
  * Log Safety: UNSAFE
1273
1298
  */
@@ -1441,6 +1466,12 @@ export interface DoesNotIntersectPolygonQuery {
1441
1466
  propertyIdentifier?: PropertyIdentifier;
1442
1467
  value: PolygonValue;
1443
1468
  }
1469
+ /**
1470
+ * Log Safety: UNSAFE
1471
+ */
1472
+ export interface DoubleValue {
1473
+ value: number;
1474
+ }
1444
1475
  /**
1445
1476
  * The vector to search with. The vector must be of the same dimension as the vectors stored in the provided
1446
1477
  propertyIdentifier.
@@ -1476,6 +1507,34 @@ export type DurationFormatStyle = ({
1476
1507
  * Log Safety: SAFE
1477
1508
  */
1478
1509
  export type DurationPrecision = "DAYS" | "HOURS" | "MINUTES" | "SECONDS" | "AUTO";
1510
+ /**
1511
+ * Log Safety: UNSAFE
1512
+ */
1513
+ export type EditHistoryEdit = ({
1514
+ type: "createEdit";
1515
+ } & CreateEdit) | ({
1516
+ type: "deleteEdit";
1517
+ } & DeleteEdit) | ({
1518
+ type: "modifyEdit";
1519
+ } & ModifyEdit);
1520
+ /**
1521
+ * Log Safety: UNSAFE
1522
+ */
1523
+ export interface EditsHistoryFilters {
1524
+ startTime?: string;
1525
+ endTime?: string;
1526
+ actionTypes: Array<ActionTypeApiName>;
1527
+ editTypes: Array<EditTypeFilter>;
1528
+ userIds: Array<string>;
1529
+ }
1530
+ /**
1531
+ * Log Safety: SAFE
1532
+ */
1533
+ export type EditsHistorySortOrder = "newest_first" | "oldest_first";
1534
+ /**
1535
+ * Log Safety: SAFE
1536
+ */
1537
+ export type EditTypeFilter = "create" | "modify" | "delete";
1479
1538
  /**
1480
1539
  * Log Safety: UNSAFE
1481
1540
  */
@@ -1778,6 +1837,12 @@ export interface InQuery {
1778
1837
  propertyIdentifier?: PropertyIdentifier;
1779
1838
  value: Array<PropertyValue>;
1780
1839
  }
1840
+ /**
1841
+ * Log Safety: UNSAFE
1842
+ */
1843
+ export interface IntegerValue {
1844
+ value: number;
1845
+ }
1781
1846
  /**
1782
1847
  * An interface property type with an additional field to indicate constraints that need to be satisfied by
1783
1848
  implementing object property types.
@@ -1792,6 +1857,7 @@ export interface InterfaceDefinedPropertyType {
1792
1857
  dataType: ObjectPropertyType;
1793
1858
  valueTypeApiName?: ValueTypeApiName;
1794
1859
  requireImplementation: boolean;
1860
+ typeClasses: Array<TypeClass>;
1795
1861
  }
1796
1862
  /**
1797
1863
  * A link type constraint defined at the interface level where the implementation of the links is provided
@@ -1941,6 +2007,7 @@ export interface InterfaceSharedPropertyType {
1941
2007
  valueTypeApiName?: ValueTypeApiName;
1942
2008
  valueFormatting?: PropertyValueFormattingRule;
1943
2009
  required: boolean;
2010
+ typeClasses: Array<TypeClass>;
1944
2011
  }
1945
2012
  /**
1946
2013
  * Represents an implementation of an interface (the mapping of interface property to local property).
@@ -2513,6 +2580,12 @@ export type LogicRuleArgument = ({
2513
2580
  } & ObjectParameterPropertyArgument) | ({
2514
2581
  type: "uniqueIdentifier";
2515
2582
  } & UniqueIdentifierArgument);
2583
+ /**
2584
+ * Log Safety: UNSAFE
2585
+ */
2586
+ export interface LongValue {
2587
+ value: string;
2588
+ }
2516
2589
  /**
2517
2590
  * Returns objects where the specified field is less than or equal to a value.
2518
2591
  *
@@ -2623,6 +2696,14 @@ export interface MinAggregationV2 {
2623
2696
  name?: AggregationMetricName;
2624
2697
  direction?: OrderByDirection;
2625
2698
  }
2699
+ /**
2700
+ * Log Safety: UNSAFE
2701
+ */
2702
+ export interface ModifyEdit {
2703
+ includesAllPreviousValues?: boolean;
2704
+ previousProperties: Record<PropertyApiName, PropertyValue>;
2705
+ properties: Record<PropertyApiName, PropertyValue>;
2706
+ }
2626
2707
  /**
2627
2708
  * Log Safety: UNSAFE
2628
2709
  */
@@ -2933,6 +3014,19 @@ export type ObjectEdit = ({
2933
3014
  } & DeleteLink) | ({
2934
3015
  type: "addLink";
2935
3016
  } & AddLink);
3017
+ /**
3018
+ * Represents a single object edit operation in the history. This captures when an object was
3019
+ created, modified, or deleted as part of an action execution.
3020
+ *
3021
+ * Log Safety: UNSAFE
3022
+ */
3023
+ export interface ObjectEditHistoryEntry {
3024
+ operationId: ActionRid;
3025
+ actionTypeRid: ActionTypeRid;
3026
+ userId: string;
3027
+ timestamp: string;
3028
+ edit: EditHistoryEdit;
3029
+ }
2936
3030
  /**
2937
3031
  * Log Safety: UNSAFE
2938
3032
  */
@@ -2974,6 +3068,10 @@ export interface ObjectParameterPropertyArgument {
2974
3068
  * Log Safety: UNSAFE
2975
3069
  */
2976
3070
  export type ObjectPrimaryKey = Record<PropertyApiName, PropertyValue>;
3071
+ /**
3072
+ * Log Safety: UNSAFE
3073
+ */
3074
+ export type ObjectPrimaryKeyV2 = Record<PropertyApiName, PrimaryKeyValueV2>;
2977
3075
  /**
2978
3076
  * A union of all the types supported by Ontology Object properties.
2979
3077
  *
@@ -3297,6 +3395,32 @@ export type ObjectTypeApiName = LooselyBrandedString<"ObjectTypeApiName">;
3297
3395
  export interface ObjectTypeEdits {
3298
3396
  editedObjectTypes: Array<ObjectTypeApiName>;
3299
3397
  }
3398
+ /**
3399
+ * Request object for querying object type edits history, containing both filters and pagination parameters
3400
+ If objectPrimaryKey property is set, the method will return edits history for the particular object.
3401
+ Otherwise, the method will return edits history for all objects of this object type.
3402
+ *
3403
+ * Log Safety: UNSAFE
3404
+ */
3405
+ export interface ObjectTypeEditsHistoryRequest {
3406
+ objectPrimaryKey?: ObjectPrimaryKeyV2;
3407
+ filters?: EditsHistoryFilters;
3408
+ sortOrder?: EditsHistorySortOrder;
3409
+ includeAllPreviousProperties?: boolean;
3410
+ pageSize?: number;
3411
+ pageToken?: string;
3412
+ }
3413
+ /**
3414
+ * Response containing the history of edits for objects of a specific object type.
3415
+ Only contains object edits (create, modify, delete) - link edits are not included.
3416
+ *
3417
+ * Log Safety: UNSAFE
3418
+ */
3419
+ export interface ObjectTypeEditsHistoryResponse {
3420
+ data: Array<ObjectEditHistoryEntry>;
3421
+ totalCount?: number;
3422
+ nextPageToken?: string;
3423
+ }
3300
3424
  /**
3301
3425
  * Log Safety: UNSAFE
3302
3426
  */
@@ -3600,6 +3724,10 @@ export interface OntologyValueType {
3600
3724
  version: string;
3601
3725
  constraints: Array<ValueTypeConstraint>;
3602
3726
  }
3727
+ /**
3728
+ * Log Safety: SAFE
3729
+ */
3730
+ export type OntologyVersion = string;
3603
3731
  /**
3604
3732
  * A command representing the list of properties to order by. Properties should be delimited by commas and
3605
3733
  prefixed by p or properties. The format expected format is
@@ -3792,6 +3920,24 @@ export interface PrefixQuery {
3792
3920
  * Log Safety: UNSAFE
3793
3921
  */
3794
3922
  export type PrimaryKeyValue = any;
3923
+ /**
3924
+ * Log Safety: UNSAFE
3925
+ */
3926
+ export type PrimaryKeyValueV2 = ({
3927
+ type: "dateValue";
3928
+ } & DateValue) | ({
3929
+ type: "stringValue";
3930
+ } & StringValue) | ({
3931
+ type: "timestampValue";
3932
+ } & TimestampValue) | ({
3933
+ type: "booleanValue";
3934
+ } & BooleanValue) | ({
3935
+ type: "integerValue";
3936
+ } & IntegerValue) | ({
3937
+ type: "doubleValue";
3938
+ } & DoubleValue) | ({
3939
+ type: "longValue";
3940
+ } & LongValue);
3795
3941
  /**
3796
3942
  * Details about some property of an object.
3797
3943
  *
@@ -4007,6 +4153,8 @@ export type PropertyTypeReferenceOrStringConstant = ({
4007
4153
  type: "propertyType";
4008
4154
  } & PropertyTypeReference);
4009
4155
  /**
4156
+ * The unique resource identifier of a property.
4157
+ *
4010
4158
  * Log Safety: SAFE
4011
4159
  */
4012
4160
  export type PropertyTypeRid = LooselyBrandedString<"PropertyTypeRid">;
@@ -4042,6 +4190,7 @@ export interface PropertyV2 {
4042
4190
  visibility?: PropertyTypeVisibility;
4043
4191
  valueTypeApiName?: ValueTypeApiName;
4044
4192
  valueFormatting?: PropertyValueFormattingRule;
4193
+ typeClasses: Array<TypeClass>;
4045
4194
  }
4046
4195
  /**
4047
4196
  * Represents the value of a property in the following format.
@@ -4904,6 +5053,7 @@ export interface SharedPropertyType {
4904
5053
  dataType: ObjectPropertyType;
4905
5054
  valueTypeApiName?: ValueTypeApiName;
4906
5055
  valueFormatting?: PropertyValueFormattingRule;
5056
+ typeClasses: Array<TypeClass>;
4907
5057
  }
4908
5058
  /**
4909
5059
  * The name of the shared property type in the API in lowerCamelCase format. To find the API name for your
@@ -4938,6 +5088,18 @@ export interface StartsWithQuery {
4938
5088
  export interface StaticArgument {
4939
5089
  value: DataValue;
4940
5090
  }
5091
+ /**
5092
+ * Log Safety: UNSAFE
5093
+ */
5094
+ export interface StreamGeotemporalSeriesValuesRequest {
5095
+ range?: TimeRange;
5096
+ }
5097
+ /**
5098
+ * Log Safety: UNSAFE
5099
+ */
5100
+ export interface StreamGeotemporalSeriesValuesResponse {
5101
+ data: Array<GeotemporalSeriesEntry>;
5102
+ }
4941
5103
  /**
4942
5104
  * Which format to serialize the binary stream in.
4943
5105
  ARROW is more efficient for streaming a large sized response.
@@ -5009,6 +5171,12 @@ export interface StringRegexMatchConstraint {
5009
5171
  regex: string;
5010
5172
  configuredFailureMessage?: string;
5011
5173
  }
5174
+ /**
5175
+ * Log Safety: UNSAFE
5176
+ */
5177
+ export interface StringValue {
5178
+ value: string;
5179
+ }
5012
5180
  /**
5013
5181
  * Log Safety: UNSAFE
5014
5182
  */
@@ -5101,6 +5269,7 @@ export interface StructFieldType {
5101
5269
  apiName: StructFieldApiName;
5102
5270
  rid: StructFieldTypeRid;
5103
5271
  dataType: ObjectPropertyType;
5272
+ typeClasses: Array<TypeClass>;
5104
5273
  }
5105
5274
  /**
5106
5275
  * The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.
@@ -5372,6 +5541,12 @@ export type TimeSeriesValueBankProperty = LooselyBrandedString<"TimeSeriesValueB
5372
5541
  * Log Safety: SAFE
5373
5542
  */
5374
5543
  export type TimeSeriesWindowType = "START" | "END";
5544
+ /**
5545
+ * Log Safety: UNSAFE
5546
+ */
5547
+ export interface TimestampValue {
5548
+ value: string;
5549
+ }
5375
5550
  /**
5376
5551
  * Log Safety: SAFE
5377
5552
  */
@@ -5397,6 +5572,15 @@ export interface TwoDimensionalAggregation {
5397
5572
  keyType: QueryAggregationKeyType;
5398
5573
  valueType: QueryAggregationValueType;
5399
5574
  }
5575
+ /**
5576
+ * Additional metadata that can be interpreted by user applications that interact with the Ontology
5577
+ *
5578
+ * Log Safety: UNSAFE
5579
+ */
5580
+ export interface TypeClass {
5581
+ kind: string;
5582
+ name: string;
5583
+ }
5400
5584
  /**
5401
5585
  * The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.
5402
5586
  This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.