@osdk/foundry.ontologies 2.44.0 → 2.46.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 CHANGED
@@ -1,5 +1,30 @@
1
1
  # @osdk/foundry.ontologies
2
2
 
3
+ ## 2.46.0
4
+
5
+ ### Minor Changes
6
+
7
+ - aabad9b: Regenerate platform sdks
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [aabad9b]
12
+ - @osdk/foundry.core@2.46.0
13
+ - @osdk/foundry.geo@2.46.0
14
+
15
+ ## 2.45.0
16
+
17
+ ### Minor Changes
18
+
19
+ - 1e53a63: Regenerate Platform SDKs
20
+
21
+ ### Patch Changes
22
+
23
+ - Updated dependencies [1e53a63]
24
+ - @osdk/foundry.core@2.45.0
25
+ - @osdk/foundry.geo@2.45.0
26
+ - @osdk/shared.net.platformapi@1.6.0
27
+
3
28
  ## 2.44.0
4
29
 
5
30
  ### Minor Changes
@@ -592,6 +592,8 @@ export interface AnyTermQuery {
592
592
  fuzzy?: Fuzzy;
593
593
  }
594
594
  /**
595
+ * If not specified, defaults to VALIDATE_AND_EXECUTE.
596
+ *
595
597
  * Log Safety: SAFE
596
598
  */
597
599
  export type ApplyActionMode = "VALIDATE_ONLY" | "VALIDATE_AND_EXECUTE";
@@ -907,6 +909,8 @@ export interface BatchedFunctionLogicRule {
907
909
  functionRule: FunctionLogicRule;
908
910
  }
909
911
  /**
912
+ * If not specified, defaults to NONE.
913
+ *
910
914
  * Log Safety: SAFE
911
915
  */
912
916
  export type BatchReturnEditsMode = "ALL" | "NONE";
@@ -945,6 +949,36 @@ export type CenterPointTypes = {
945
949
  * Log Safety: UNSAFE
946
950
  */
947
951
  export type CipherTextProperty = LooselyBrandedString<"CipherTextProperty">;
952
+ /**
953
+ * The conjunctive set of markings required to access the property value.
954
+ All markings from a conjunctive set must be met for access.
955
+ *
956
+ * Log Safety: UNSAFE
957
+ */
958
+ export type ConjunctiveMarkingSummary = Array<MarkingId>;
959
+ /**
960
+ * The conjunctive set of markings for the container of this property value,
961
+ such as the project of a dataset. These markings may differ from the marking
962
+ on the actual property value, but still must be satisfied for accessing the property
963
+ All markings from a conjunctive set must be met for access.
964
+ *
965
+ * Log Safety: UNSAFE
966
+ */
967
+ export type ContainerConjunctiveMarkingSummary = Array<MarkingId>;
968
+ /**
969
+ * The disjunctive set of markings for the container of this property value,
970
+ such as the project of a dataset. These markings may differ from the marking
971
+ on the actual property value, but still must be satisfied for accessing the property
972
+
973
+ All markings from a conjunctive set must be met for access.
974
+ Disjunctive markings are represented as a conjunctive list of disjunctive sets.
975
+ The top-level set is a conjunction of sets, where each inner set should be
976
+ treated as a unit where any marking within the set can satisfy the set.
977
+ All sets within the top level set should be satisfied.
978
+ *
979
+ * Log Safety: UNSAFE
980
+ */
981
+ export type ContainerDisjunctiveMarkingSummary = Array<Array<MarkingId>>;
948
982
  /**
949
983
  * Returns objects where the specified field contains all of the terms in the order provided,
950
984
  but they do have to be adjacent to each other.
@@ -1364,6 +1398,16 @@ export interface DerivedTimeSeriesProperty {
1364
1398
  templateRid: TimeseriesTemplateRid;
1365
1399
  templateVersion?: TimeseriesTemplateVersion;
1366
1400
  }
1401
+ /**
1402
+ * The disjunctive set of markings required to access the property value.
1403
+ Disjunctive markings are represented as a conjunctive list of disjunctive sets.
1404
+ The top-level set is a conjunction of sets, where each inner set should be
1405
+ treated as a unit where any marking within the set can satisfy the set.
1406
+ All sets within the top level set should be satisfied.
1407
+ *
1408
+ * Log Safety: UNSAFE
1409
+ */
1410
+ export type DisjunctiveMarkingSummary = Array<Array<MarkingId>>;
1367
1411
  /**
1368
1412
  * Divides the left numeric value by the right numeric value.
1369
1413
  *
@@ -1472,6 +1516,13 @@ export interface Error {
1472
1516
  error: ErrorName;
1473
1517
  args: Array<Arg>;
1474
1518
  }
1519
+ /**
1520
+ * Indicates the server was not able to load the securities of the property.
1521
+ *
1522
+ * Log Safety: SAFE
1523
+ */
1524
+ export interface ErrorComputingSecurity {
1525
+ }
1475
1526
  /**
1476
1527
  * Log Safety: SAFE
1477
1528
  */
@@ -1591,6 +1642,19 @@ export type Fuzzy = boolean;
1591
1642
  * Log Safety: SAFE
1592
1643
  */
1593
1644
  export type FuzzyV2 = boolean;
1645
+ /**
1646
+ * A single geotemporal data point representing the location of an entity at a specific point in time.
1647
+ *
1648
+ * Log Safety: UNSAFE
1649
+ */
1650
+ export interface GeotemporalSeriesEntry {
1651
+ time: string;
1652
+ position: _Geo.GeoPoint;
1653
+ }
1654
+ /**
1655
+ * Log Safety: UNSAFE
1656
+ */
1657
+ export type GeotemporalSeriesProperty = LooselyBrandedString<"GeotemporalSeriesProperty">;
1594
1658
  /**
1595
1659
  * The unique id of a geotime series (track) associated with a GTSR.
1596
1660
  *
@@ -1704,8 +1768,8 @@ export type Icon = {
1704
1768
  } & BlueprintIcon;
1705
1769
  /**
1706
1770
  * Returns objects where the specified field equals any of the provided values. Allows you to
1707
- specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied,
1708
- but not both.
1771
+ 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
1772
+ in the object set. Either field or propertyIdentifier must be supplied, but not both.
1709
1773
  *
1710
1774
  * Log Safety: UNSAFE
1711
1775
  */
@@ -2313,6 +2377,7 @@ export interface LoadObjectSetRequestV2 {
2313
2377
  pageToken?: _Core.PageToken;
2314
2378
  pageSize?: _Core.PageSize;
2315
2379
  excludeRid?: boolean;
2380
+ loadPropertySecurities?: boolean;
2316
2381
  snapshot?: boolean;
2317
2382
  includeComputeUsage?: _Core.IncludeComputeUsage;
2318
2383
  }
@@ -2326,6 +2391,7 @@ export interface LoadObjectSetResponseV2 {
2326
2391
  nextPageToken?: _Core.PageToken;
2327
2392
  totalCount: _Core.TotalCount;
2328
2393
  computeUsage?: _Core.ComputeSeconds;
2394
+ propertySecurities: Array<PropertySecurities>;
2329
2395
  }
2330
2396
  /**
2331
2397
  * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsMultipleObjectTypes endpoint only.
@@ -2340,6 +2406,7 @@ export interface LoadObjectSetV2MultipleObjectTypesRequest {
2340
2406
  pageToken?: _Core.PageToken;
2341
2407
  pageSize?: _Core.PageSize;
2342
2408
  excludeRid?: boolean;
2409
+ loadPropertySecurities?: boolean;
2343
2410
  snapshot?: boolean;
2344
2411
  includeComputeUsage?: _Core.IncludeComputeUsage;
2345
2412
  }
@@ -2364,6 +2431,7 @@ export interface LoadObjectSetV2MultipleObjectTypesResponse {
2364
2431
  interfaceToObjectTypeMappings: Record<InterfaceTypeApiName, InterfaceToObjectTypeMappings>;
2365
2432
  interfaceToObjectTypeMappingsV2: Record<InterfaceTypeApiName, InterfaceToObjectTypeMappingsV2>;
2366
2433
  computeUsage?: _Core.ComputeSeconds;
2434
+ propertySecurities: Array<PropertySecurities>;
2367
2435
  }
2368
2436
  /**
2369
2437
  * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsOrInterfaces endpoint only.
@@ -2485,6 +2553,12 @@ export interface LtQueryV2 {
2485
2553
  propertyIdentifier?: PropertyIdentifier;
2486
2554
  value: PropertyValue;
2487
2555
  }
2556
+ /**
2557
+ * The id of a classification or mandatory marking.
2558
+ *
2559
+ * Log Safety: UNSAFE
2560
+ */
2561
+ export type MarkingId = LooselyBrandedString<"MarkingId">;
2488
2562
  /**
2489
2563
  * Matches intervals containing the terms in the query
2490
2564
  *
@@ -3243,6 +3317,8 @@ export type ObjectTypeId = LooselyBrandedString<"ObjectTypeId">;
3243
3317
  * Log Safety: UNSAFE
3244
3318
  */
3245
3319
  export interface ObjectTypeInterfaceImplementation {
3320
+ apiName?: InterfaceTypeApiName;
3321
+ rid?: InterfaceTypeRid;
3246
3322
  properties: Record<SharedPropertyTypeApiName, PropertyApiName>;
3247
3323
  propertiesV2: Record<InterfacePropertyApiName, InterfacePropertyTypeImplementation>;
3248
3324
  links: Record<InterfaceLinkTypeApiName, Array<LinkTypeApiName>>;
@@ -3836,6 +3912,17 @@ export type PropertyLoadLevel = ({
3836
3912
  } & ApplyReducersLoadLevel) | ({
3837
3913
  type: "extractMainValue";
3838
3914
  } & ExtractMainValueLoadLevel);
3915
+ /**
3916
+ * All marking requirements applicable to a property value.
3917
+ *
3918
+ * Log Safety: UNSAFE
3919
+ */
3920
+ export interface PropertyMarkingSummary {
3921
+ conjunctive?: ConjunctiveMarkingSummary;
3922
+ disjunctive?: DisjunctiveMarkingSummary;
3923
+ containerConjunctive?: ContainerConjunctiveMarkingSummary;
3924
+ containerDisjunctive?: ContainerDisjunctiveMarkingSummary;
3925
+ }
3839
3926
  /**
3840
3927
  * Wrapper for numeric formatting options.
3841
3928
  *
@@ -3874,6 +3961,24 @@ export type PropertyOrStructFieldOfPropertyImplementation = ({
3874
3961
  } & StructFieldOfPropertyImplementation) | ({
3875
3962
  type: "property";
3876
3963
  } & PropertyImplementation);
3964
+ /**
3965
+ * A disjunctive set of security results for a property value.
3966
+ *
3967
+ * Log Safety: UNSAFE
3968
+ */
3969
+ export interface PropertySecurities {
3970
+ disjunction: Array<PropertySecurity>;
3971
+ }
3972
+ /**
3973
+ * Log Safety: UNSAFE
3974
+ */
3975
+ export type PropertySecurity = ({
3976
+ type: "propertyMarkingSummary";
3977
+ } & PropertyMarkingSummary) | ({
3978
+ type: "unsupportedPolicy";
3979
+ } & UnsupportedPolicy) | ({
3980
+ type: "errorComputingSecurity";
3981
+ } & ErrorComputingSecurity);
3877
3982
  /**
3878
3983
  * Formatting configuration for timestamp property values.
3879
3984
  *
@@ -3957,6 +4062,7 @@ export interface PropertyV2 {
3957
4062
  | Integer | number | 238940 |
3958
4063
  | Long | string | "58319870951433" |
3959
4064
  | MediaReference| JSON encoded MediaReference object | {"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}} |
4065
+ | Secured Property Value | JSON encoded SecuredPropertyValue object | {"value": 10, "propertySecurityIndex" : 5} |
3960
4066
  | Short | number | 8739 |
3961
4067
  | String | string | "Call me Ishmael" |
3962
4068
  | Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} |
@@ -4411,6 +4517,8 @@ export interface ResolvedInterfacePropertyType {
4411
4517
  requireImplementation: boolean;
4412
4518
  }
4413
4519
  /**
4520
+ * If not specified, defaults to NONE.
4521
+ *
4414
4522
  * Log Safety: SAFE
4415
4523
  */
4416
4524
  export type ReturnEditsMode = "ALL" | "ALL_V2_WITH_DELETIONS" | "NONE";
@@ -4621,6 +4729,13 @@ export interface SearchOrderingV2 {
4621
4729
  field: PropertyApiName;
4622
4730
  direction?: string;
4623
4731
  }
4732
+ /**
4733
+ * Log Safety: UNSAFE
4734
+ */
4735
+ export interface SecuredPropertyValue {
4736
+ value?: PropertyValue;
4737
+ propertySecurityIndex?: number;
4738
+ }
4624
4739
  /**
4625
4740
  * By default, whenever an object is requested, all of its properties are returned, except for properties of the
4626
4741
  following types:
@@ -5311,6 +5426,13 @@ the value being automatically generated.
5311
5426
  * Log Safety: SAFE
5312
5427
  */
5313
5428
  export type UniqueIdentifierValue = string;
5429
+ /**
5430
+ * Indicates the property is backed by a restricted view that does not support property securities.
5431
+ *
5432
+ * Log Safety: SAFE
5433
+ */
5434
+ export interface UnsupportedPolicy {
5435
+ }
5314
5436
  /**
5315
5437
  * The string must be a valid UUID (Universally Unique Identifier).
5316
5438
  *