@osdk/foundry.ontologies 2.47.0 → 2.49.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.
- package/CHANGELOG.md +24 -0
- package/build/browser/_components.d.ts +106 -14
- package/build/browser/_components.d.ts.map +1 -1
- package/build/browser/index.d.ts +1 -1
- package/build/browser/index.d.ts.map +1 -1
- package/build/browser/public/ActionTypeV2.d.ts +20 -0
- package/build/browser/public/ActionTypeV2.d.ts.map +1 -1
- package/build/browser/public/ActionTypeV2.js +17 -0
- package/build/browser/public/ActionTypeV2.js.map +1 -1
- package/build/browser/public/ObjectTypeV2.d.ts +3 -4
- package/build/browser/public/ObjectTypeV2.d.ts.map +1 -1
- package/build/browser/public/ObjectTypeV2.js +3 -4
- package/build/browser/public/ObjectTypeV2.js.map +1 -1
- package/build/browser/public/OntologyObjectSet.d.ts +1 -0
- package/build/browser/public/OntologyObjectSet.d.ts.map +1 -1
- package/build/esm/_components.d.ts +106 -14
- package/build/esm/_components.d.ts.map +1 -1
- package/build/esm/index.d.ts +1 -1
- package/build/esm/index.d.ts.map +1 -1
- package/build/esm/public/ActionTypeV2.d.ts +20 -0
- package/build/esm/public/ActionTypeV2.d.ts.map +1 -1
- package/build/esm/public/ActionTypeV2.js +17 -0
- package/build/esm/public/ActionTypeV2.js.map +1 -1
- package/build/esm/public/ObjectTypeV2.d.ts +3 -4
- package/build/esm/public/ObjectTypeV2.d.ts.map +1 -1
- package/build/esm/public/ObjectTypeV2.js +3 -4
- package/build/esm/public/ObjectTypeV2.js.map +1 -1
- package/build/esm/public/OntologyObjectSet.d.ts +1 -0
- package/build/esm/public/OntologyObjectSet.d.ts.map +1 -1
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
# @osdk/foundry.ontologies
|
|
2
2
|
|
|
3
|
+
## 2.49.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- ed3ac19: Regenerate Platform SDKs
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies [ed3ac19]
|
|
12
|
+
- @osdk/foundry.core@2.49.0
|
|
13
|
+
- @osdk/foundry.geo@2.49.0
|
|
14
|
+
|
|
15
|
+
## 2.48.0
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- 21e4edc: Regenerate Platform SDKs
|
|
20
|
+
|
|
21
|
+
### Patch Changes
|
|
22
|
+
|
|
23
|
+
- Updated dependencies [21e4edc]
|
|
24
|
+
- @osdk/foundry.core@2.48.0
|
|
25
|
+
- @osdk/foundry.geo@2.48.0
|
|
26
|
+
|
|
3
27
|
## 2.47.0
|
|
4
28
|
|
|
5
29
|
### Minor Changes
|
|
@@ -231,7 +231,7 @@ export interface AddObject {
|
|
|
231
231
|
*/
|
|
232
232
|
export interface AddObjectEdit {
|
|
233
233
|
objectType: ObjectTypeApiName;
|
|
234
|
-
properties: Record<PropertyApiName, DataValue>;
|
|
234
|
+
properties: Record<PropertyApiName, DataValue | undefined>;
|
|
235
235
|
}
|
|
236
236
|
/**
|
|
237
237
|
* Adds two or more numeric values.
|
|
@@ -1520,17 +1520,28 @@ export type EditHistoryEdit = ({
|
|
|
1520
1520
|
/**
|
|
1521
1521
|
* Log Safety: UNSAFE
|
|
1522
1522
|
*/
|
|
1523
|
-
export
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
|
|
1523
|
+
export type EditsHistoryFilter = ({
|
|
1524
|
+
type: "timestampFilter";
|
|
1525
|
+
} & EditsHistoryTimestampFilter) | ({
|
|
1526
|
+
type: "operationIdsFilter";
|
|
1527
|
+
} & EditsHistoryOperationIdsFilter);
|
|
1528
|
+
/**
|
|
1529
|
+
* Log Safety: SAFE
|
|
1530
|
+
*/
|
|
1531
|
+
export interface EditsHistoryOperationIdsFilter {
|
|
1532
|
+
operationIds: Array<ActionRid>;
|
|
1529
1533
|
}
|
|
1530
1534
|
/**
|
|
1531
1535
|
* Log Safety: SAFE
|
|
1532
1536
|
*/
|
|
1533
1537
|
export type EditsHistorySortOrder = "newest_first" | "oldest_first";
|
|
1538
|
+
/**
|
|
1539
|
+
* Log Safety: SAFE
|
|
1540
|
+
*/
|
|
1541
|
+
export interface EditsHistoryTimestampFilter {
|
|
1542
|
+
startTime?: string;
|
|
1543
|
+
endTime?: string;
|
|
1544
|
+
}
|
|
1534
1545
|
/**
|
|
1535
1546
|
* Log Safety: SAFE
|
|
1536
1547
|
*/
|
|
@@ -1549,10 +1560,11 @@ export interface EnumConstraint {
|
|
|
1549
1560
|
options: Array<PropertyValue | undefined>;
|
|
1550
1561
|
}
|
|
1551
1562
|
/**
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1563
|
+
* Returns objects where the specified field is equal to a value.
|
|
1564
|
+
For string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.
|
|
1565
|
+
*
|
|
1566
|
+
* Log Safety: UNSAFE
|
|
1567
|
+
*/
|
|
1556
1568
|
export interface EqualsQuery {
|
|
1557
1569
|
field: FieldNameV1;
|
|
1558
1570
|
value: PropertyValue;
|
|
@@ -1560,6 +1572,7 @@ export interface EqualsQuery {
|
|
|
1560
1572
|
/**
|
|
1561
1573
|
* Returns objects where the specified field is equal to a value. Allows you to specify a property to query on
|
|
1562
1574
|
by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
|
|
1575
|
+
For string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.
|
|
1563
1576
|
*
|
|
1564
1577
|
* Log Safety: UNSAFE
|
|
1565
1578
|
*/
|
|
@@ -1695,12 +1708,54 @@ export type FunctionVersion = LooselyBrandedString<"FunctionVersion">;
|
|
|
1695
1708
|
* Log Safety: SAFE
|
|
1696
1709
|
*/
|
|
1697
1710
|
export type Fuzzy = boolean;
|
|
1711
|
+
/**
|
|
1712
|
+
* Matches intervals containing terms that are similar to the provided term, within an edit distance
|
|
1713
|
+
defined by fuzziness. An edit is a single character change needed to make a term match, including
|
|
1714
|
+
character insertion, deletion, substitution, or transposition of two adjacent characters.
|
|
1715
|
+
*
|
|
1716
|
+
* Log Safety: UNSAFE
|
|
1717
|
+
*/
|
|
1718
|
+
export interface FuzzyRule {
|
|
1719
|
+
term: string;
|
|
1720
|
+
fuzziness?: number;
|
|
1721
|
+
}
|
|
1698
1722
|
/**
|
|
1699
1723
|
* Setting fuzzy to true allows approximate matching in search queries that support it.
|
|
1700
1724
|
*
|
|
1701
1725
|
* Log Safety: SAFE
|
|
1702
1726
|
*/
|
|
1703
1727
|
export type FuzzyV2 = boolean;
|
|
1728
|
+
/**
|
|
1729
|
+
* A GeoJSON geometry specification.
|
|
1730
|
+
*
|
|
1731
|
+
* Log Safety: UNSAFE
|
|
1732
|
+
*/
|
|
1733
|
+
export interface GeoJsonString {
|
|
1734
|
+
geoJson: string;
|
|
1735
|
+
}
|
|
1736
|
+
/**
|
|
1737
|
+
* Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.
|
|
1738
|
+
*
|
|
1739
|
+
* Log Safety: UNSAFE
|
|
1740
|
+
*/
|
|
1741
|
+
export type GeoShapeV2Geometry = ({
|
|
1742
|
+
type: "envelope";
|
|
1743
|
+
} & BoundingBoxValue) | ({
|
|
1744
|
+
type: "geoJson";
|
|
1745
|
+
} & GeoJsonString);
|
|
1746
|
+
/**
|
|
1747
|
+
* Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.
|
|
1748
|
+
Supports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.
|
|
1749
|
+
Either field or propertyIdentifier can be supplied, but not both.
|
|
1750
|
+
*
|
|
1751
|
+
* Log Safety: UNSAFE
|
|
1752
|
+
*/
|
|
1753
|
+
export interface GeoShapeV2Query {
|
|
1754
|
+
field?: PropertyApiName;
|
|
1755
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
1756
|
+
geometry: GeoShapeV2Geometry;
|
|
1757
|
+
spatialFilterMode: SpatialFilterMode;
|
|
1758
|
+
}
|
|
1704
1759
|
/**
|
|
1705
1760
|
* A single geotemporal data point representing the location of an entity at a specific point in time.
|
|
1706
1761
|
*
|
|
@@ -1744,6 +1799,24 @@ export interface GeotimeSeriesValue {
|
|
|
1744
1799
|
position: _Geo.Position;
|
|
1745
1800
|
timestamp: string;
|
|
1746
1801
|
}
|
|
1802
|
+
/**
|
|
1803
|
+
* Log Safety: SAFE
|
|
1804
|
+
*/
|
|
1805
|
+
export interface GetActionTypeByRidBatchRequest {
|
|
1806
|
+
requests: Array<GetActionTypeByRidBatchRequestElement>;
|
|
1807
|
+
}
|
|
1808
|
+
/**
|
|
1809
|
+
* Log Safety: SAFE
|
|
1810
|
+
*/
|
|
1811
|
+
export interface GetActionTypeByRidBatchRequestElement {
|
|
1812
|
+
actionTypeRid: ActionTypeRid;
|
|
1813
|
+
}
|
|
1814
|
+
/**
|
|
1815
|
+
* Log Safety: UNSAFE
|
|
1816
|
+
*/
|
|
1817
|
+
export interface GetActionTypeByRidBatchResponse {
|
|
1818
|
+
data: Array<ActionTypeV2>;
|
|
1819
|
+
}
|
|
1747
1820
|
/**
|
|
1748
1821
|
* Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could
|
|
1749
1822
|
explode the cardinality.
|
|
@@ -1829,6 +1902,7 @@ export type Icon = {
|
|
|
1829
1902
|
* Returns objects where the specified field equals any of the provided values. Allows you to
|
|
1830
1903
|
specify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects
|
|
1831
1904
|
in the object set. Either field or propertyIdentifier must be supplied, but not both.
|
|
1905
|
+
For string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.
|
|
1832
1906
|
*
|
|
1833
1907
|
* Log Safety: UNSAFE
|
|
1834
1908
|
*/
|
|
@@ -2112,7 +2186,9 @@ export type IntervalQueryRule = ({
|
|
|
2112
2186
|
type: "anyOf";
|
|
2113
2187
|
} & AnyOfRule) | ({
|
|
2114
2188
|
type: "prefixOnLastToken";
|
|
2115
|
-
} & PrefixOnLastTokenRule)
|
|
2189
|
+
} & PrefixOnLastTokenRule) | ({
|
|
2190
|
+
type: "fuzzy";
|
|
2191
|
+
} & FuzzyRule);
|
|
2116
2192
|
/**
|
|
2117
2193
|
* Returns objects based on the existence of the specified field.
|
|
2118
2194
|
*
|
|
@@ -2525,6 +2601,7 @@ export interface LoadObjectSetV2ObjectsOrInterfacesResponse {
|
|
|
2525
2601
|
data: Array<OntologyObjectV2>;
|
|
2526
2602
|
nextPageToken?: _Core.PageToken;
|
|
2527
2603
|
totalCount: _Core.TotalCount;
|
|
2604
|
+
transactionId?: OntologyTransactionId;
|
|
2528
2605
|
}
|
|
2529
2606
|
/**
|
|
2530
2607
|
* The Ontology metadata (i.e., object, link, action, query, and interface types) to load.
|
|
@@ -2731,7 +2808,7 @@ export interface ModifyObject {
|
|
|
2731
2808
|
export interface ModifyObjectEdit {
|
|
2732
2809
|
objectType: ObjectTypeApiName;
|
|
2733
2810
|
primaryKey: PropertyValue;
|
|
2734
|
-
properties: Record<PropertyApiName, DataValue>;
|
|
2811
|
+
properties: Record<PropertyApiName, DataValue | undefined>;
|
|
2735
2812
|
}
|
|
2736
2813
|
/**
|
|
2737
2814
|
* Log Safety: UNSAFE
|
|
@@ -3021,6 +3098,7 @@ created, modified, or deleted as part of an action execution.
|
|
|
3021
3098
|
* Log Safety: UNSAFE
|
|
3022
3099
|
*/
|
|
3023
3100
|
export interface ObjectEditHistoryEntry {
|
|
3101
|
+
objectPrimaryKey: ObjectPrimaryKeyV2;
|
|
3024
3102
|
operationId: ActionRid;
|
|
3025
3103
|
actionTypeRid: ActionTypeRid;
|
|
3026
3104
|
userId: string;
|
|
@@ -3404,7 +3482,7 @@ Otherwise, the method will return edits history for all objects of this object t
|
|
|
3404
3482
|
*/
|
|
3405
3483
|
export interface ObjectTypeEditsHistoryRequest {
|
|
3406
3484
|
objectPrimaryKey?: ObjectPrimaryKeyV2;
|
|
3407
|
-
filters?:
|
|
3485
|
+
filters?: EditsHistoryFilter;
|
|
3408
3486
|
sortOrder?: EditsHistorySortOrder;
|
|
3409
3487
|
includeAllPreviousProperties?: boolean;
|
|
3410
3488
|
pageSize?: number;
|
|
@@ -3548,6 +3626,8 @@ export type OntologyDataType = ({
|
|
|
3548
3626
|
} & _Core.MarkingType) | ({
|
|
3549
3627
|
type: "unsupported";
|
|
3550
3628
|
} & _Core.UnsupportedType) | ({
|
|
3629
|
+
type: "mediaReference";
|
|
3630
|
+
} & _Core.MediaReferenceType) | ({
|
|
3551
3631
|
type: "array";
|
|
3552
3632
|
} & OntologyArrayType) | ({
|
|
3553
3633
|
type: "objectSet";
|
|
@@ -4400,6 +4480,8 @@ export type QueryDataType = ({
|
|
|
4400
4480
|
} & _Core.UnsupportedType) | ({
|
|
4401
4481
|
type: "attachment";
|
|
4402
4482
|
} & _Core.AttachmentType) | ({
|
|
4483
|
+
type: "mediaReference";
|
|
4484
|
+
} & _Core.MediaReferenceType) | ({
|
|
4403
4485
|
type: "null";
|
|
4404
4486
|
} & _Core.NullType) | ({
|
|
4405
4487
|
type: "array";
|
|
@@ -4786,6 +4868,8 @@ export type SearchJsonQueryV2 = ({
|
|
|
4786
4868
|
} & ContainsAnyTermQuery) | ({
|
|
4787
4869
|
type: "interval";
|
|
4788
4870
|
} & IntervalQuery) | ({
|
|
4871
|
+
type: "geoShapeV2";
|
|
4872
|
+
} & GeoShapeV2Query) | ({
|
|
4789
4873
|
type: "startsWith";
|
|
4790
4874
|
} & StartsWithQuery);
|
|
4791
4875
|
/**
|
|
@@ -5068,6 +5152,14 @@ export type SharedPropertyTypeApiName = LooselyBrandedString<"SharedPropertyType
|
|
|
5068
5152
|
* Log Safety: SAFE
|
|
5069
5153
|
*/
|
|
5070
5154
|
export type SharedPropertyTypeRid = LooselyBrandedString<"SharedPropertyTypeRid">;
|
|
5155
|
+
/**
|
|
5156
|
+
* The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided
|
|
5157
|
+
geometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that
|
|
5158
|
+
lie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.
|
|
5159
|
+
*
|
|
5160
|
+
* Log Safety: SAFE
|
|
5161
|
+
*/
|
|
5162
|
+
export type SpatialFilterMode = "INTERSECTS" | "DISJOINT" | "WITHIN" | "CONTAINS";
|
|
5071
5163
|
/**
|
|
5072
5164
|
* Deprecated alias for containsAllTermsInOrderPrefixLastTerm, which is preferred because the name startsWith is misleading.
|
|
5073
5165
|
Returns objects where the specified field starts with the provided value. Allows you to specify a property to
|