@osdk/foundry.ontologies 2.43.0 → 2.44.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 (38) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/build/browser/_components.d.ts +140 -2
  3. package/build/browser/_components.d.ts.map +1 -1
  4. package/build/browser/_errors.d.ts +117 -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 +19 -0
  9. package/build/browser/public/Action.d.ts.map +1 -1
  10. package/build/browser/public/Action.js +13 -0
  11. package/build/browser/public/Action.js.map +1 -1
  12. package/build/browser/public/OntologyInterface.d.ts +2 -0
  13. package/build/browser/public/OntologyInterface.d.ts.map +1 -1
  14. package/build/browser/public/OntologyObjectSet.d.ts +10 -1
  15. package/build/browser/public/OntologyObjectSet.d.ts.map +1 -1
  16. package/build/browser/public/OntologyObjectSet.js +10 -1
  17. package/build/browser/public/OntologyObjectSet.js.map +1 -1
  18. package/build/browser/public/Query.d.ts +1 -0
  19. package/build/browser/public/Query.d.ts.map +1 -1
  20. package/build/esm/_components.d.ts +140 -2
  21. package/build/esm/_components.d.ts.map +1 -1
  22. package/build/esm/_errors.d.ts +117 -0
  23. package/build/esm/_errors.d.ts.map +1 -1
  24. package/build/esm/index.d.ts +2 -2
  25. package/build/esm/index.d.ts.map +1 -1
  26. package/build/esm/public/Action.d.ts +19 -0
  27. package/build/esm/public/Action.d.ts.map +1 -1
  28. package/build/esm/public/Action.js +13 -0
  29. package/build/esm/public/Action.js.map +1 -1
  30. package/build/esm/public/OntologyInterface.d.ts +2 -0
  31. package/build/esm/public/OntologyInterface.d.ts.map +1 -1
  32. package/build/esm/public/OntologyObjectSet.d.ts +10 -1
  33. package/build/esm/public/OntologyObjectSet.d.ts.map +1 -1
  34. package/build/esm/public/OntologyObjectSet.js +10 -1
  35. package/build/esm/public/OntologyObjectSet.js.map +1 -1
  36. package/build/esm/public/Query.d.ts +1 -0
  37. package/build/esm/public/Query.d.ts.map +1 -1
  38. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @osdk/foundry.ontologies
2
2
 
3
+ ## 2.44.0
4
+
5
+ ### Minor Changes
6
+
7
+ - cb3d72c: Regenerate Platform SDKs
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [cb3d72c]
12
+ - @osdk/foundry.core@2.44.0
13
+ - @osdk/foundry.geo@2.44.0
14
+
3
15
  ## 2.43.0
4
16
 
5
17
  ### Minor Changes
@@ -24,6 +24,12 @@ export interface AbsoluteValuePropertyExpression {
24
24
  * Log Safety: UNSAFE
25
25
  */
26
26
  export type Action = LooselyBrandedString<"Action">;
27
+ /**
28
+ * An ISO 8601 timestamp.
29
+ *
30
+ * Log Safety: SAFE
31
+ */
32
+ export type ActionExecutionTime = string;
27
33
  /**
28
34
  * A detailed operation for an Action
29
35
  *
@@ -529,6 +535,16 @@ export type AggregationV2 = ({
529
535
  } & SumAggregationV2) | ({
530
536
  type: "exactDistinct";
531
537
  } & ExactDistinctAggregationV2);
538
+ /**
539
+ * Matches intervals satisfying all the rules in the query
540
+ *
541
+ * Log Safety: UNSAFE
542
+ */
543
+ export interface AllOfRule {
544
+ rules: Array<IntervalQueryRule>;
545
+ maxGaps?: number;
546
+ ordered: boolean;
547
+ }
532
548
  /**
533
549
  * Returns objects where the specified field contains all of the whitespace separated words in any
534
550
  order in the provided value. This query supports fuzzy matching.
@@ -556,6 +572,14 @@ export interface AndQuery {
556
572
  export interface AndQueryV2 {
557
573
  value: Array<SearchJsonQueryV2>;
558
574
  }
575
+ /**
576
+ * Matches intervals satisfying any of the rules in the query
577
+ *
578
+ * Log Safety: UNSAFE
579
+ */
580
+ export interface AnyOfRule {
581
+ rules: Array<IntervalQueryRule>;
582
+ }
559
583
  /**
560
584
  * Returns objects where the specified field contains any of the whitespace separated words in any
561
585
  order in the provided value. This query supports fuzzy matching.
@@ -571,6 +595,13 @@ export interface AnyTermQuery {
571
595
  * Log Safety: SAFE
572
596
  */
573
597
  export type ApplyActionMode = "VALIDATE_ONLY" | "VALIDATE_AND_EXECUTE";
598
+ /**
599
+ * Log Safety: SAFE
600
+ */
601
+ export interface ApplyActionOverrides {
602
+ uniqueIdentifierLinkIdValues: Record<UniqueIdentifierLinkId, UniqueIdentifierValue>;
603
+ actionExecutionTime?: ActionExecutionTime;
604
+ }
574
605
  /**
575
606
  * Log Safety: UNSAFE
576
607
  */
@@ -596,6 +627,13 @@ export interface ApplyActionRequestV2 {
596
627
  */
597
628
  export interface ApplyActionResponse {
598
629
  }
630
+ /**
631
+ * Log Safety: UNSAFE
632
+ */
633
+ export interface ApplyActionWithOverridesRequest {
634
+ request: ApplyActionRequestV2;
635
+ overrides: ApplyActionOverrides;
636
+ }
599
637
  /**
600
638
  * Performs both apply reducers and extract main value to return the reduced main value.
601
639
  *
@@ -1761,6 +1799,14 @@ export type InterfacePropertyApiName = LooselyBrandedString<"InterfacePropertyAp
1761
1799
  export interface InterfacePropertyLocalPropertyImplementation {
1762
1800
  propertyApiName: PropertyApiName;
1763
1801
  }
1802
+ /**
1803
+ * An implementation of an interface property via applying reducers on the nested implementation.
1804
+ *
1805
+ * Log Safety: UNSAFE
1806
+ */
1807
+ export interface InterfacePropertyReducedPropertyImplementation {
1808
+ implementation: NestedInterfacePropertyTypeImplementation;
1809
+ }
1764
1810
  /**
1765
1811
  * An implementation of an interface property via the field of a local struct property.
1766
1812
  *
@@ -1775,7 +1821,16 @@ struct fields to local struct fields or properties.
1775
1821
  *
1776
1822
  * Log Safety: UNSAFE
1777
1823
  */
1778
- export type InterfacePropertyStructImplementation = Record<StructFieldApiName, PropertyOrStructFieldOfPropertyImplementation>;
1824
+ export interface InterfacePropertyStructImplementation {
1825
+ mapping: InterfacePropertyStructImplementationMapping;
1826
+ }
1827
+ /**
1828
+ * An implementation of a struct interface property via a local struct property. Specifies a mapping of interface
1829
+ struct fields to local struct fields or properties.
1830
+ *
1831
+ * Log Safety: UNSAFE
1832
+ */
1833
+ export type InterfacePropertyStructImplementationMapping = Record<StructFieldApiName, PropertyOrStructFieldOfPropertyImplementation>;
1779
1834
  /**
1780
1835
  * The definition of an interface property type on an interface. An interface property can either be backed by a
1781
1836
  shared property type or defined on the interface directly.
@@ -1798,7 +1853,9 @@ export type InterfacePropertyTypeImplementation = ({
1798
1853
  type: "structImplementation";
1799
1854
  } & InterfacePropertyStructImplementation) | ({
1800
1855
  type: "localPropertyImplementation";
1801
- } & InterfacePropertyLocalPropertyImplementation);
1856
+ } & InterfacePropertyLocalPropertyImplementation) | ({
1857
+ type: "reducedPropertyImplementation";
1858
+ } & InterfacePropertyReducedPropertyImplementation);
1802
1859
  /**
1803
1860
  * The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.
1804
1861
  *
@@ -1900,6 +1957,31 @@ export interface IntersectsPolygonQuery {
1900
1957
  propertyIdentifier?: PropertyIdentifier;
1901
1958
  value: PolygonValue;
1902
1959
  }
1960
+ /**
1961
+ * Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of
1962
+ text fields. Either field or propertyIdentifier can be supplied, but not both.
1963
+ *
1964
+ * Log Safety: UNSAFE
1965
+ */
1966
+ export interface IntervalQuery {
1967
+ field?: PropertyApiName;
1968
+ propertyIdentifier?: PropertyIdentifier;
1969
+ rule: IntervalQueryRule;
1970
+ }
1971
+ /**
1972
+ * Sub-rule used for evaluating an IntervalQuery
1973
+ *
1974
+ * Log Safety: UNSAFE
1975
+ */
1976
+ export type IntervalQueryRule = ({
1977
+ type: "allOf";
1978
+ } & AllOfRule) | ({
1979
+ type: "match";
1980
+ } & MatchRule) | ({
1981
+ type: "anyOf";
1982
+ } & AnyOfRule) | ({
1983
+ type: "prefixOnLastToken";
1984
+ } & PrefixOnLastTokenRule);
1903
1985
  /**
1904
1986
  * Returns objects based on the existence of the specified field.
1905
1987
  *
@@ -2403,6 +2485,16 @@ export interface LtQueryV2 {
2403
2485
  propertyIdentifier?: PropertyIdentifier;
2404
2486
  value: PropertyValue;
2405
2487
  }
2488
+ /**
2489
+ * Matches intervals containing the terms in the query
2490
+ *
2491
+ * Log Safety: UNSAFE
2492
+ */
2493
+ export interface MatchRule {
2494
+ query: string;
2495
+ maxGaps?: number;
2496
+ ordered: boolean;
2497
+ }
2406
2498
  /**
2407
2499
  * Computes the maximum value for the provided field.
2408
2500
  *
@@ -2535,6 +2627,19 @@ export interface NearestNeighborsQueryText {
2535
2627
  export interface NegatePropertyExpression {
2536
2628
  property: DerivedPropertyDefinition;
2537
2629
  }
2630
+ /**
2631
+ * Describes how an object type implements an interface property when a reducer is applied to it. Is missing a
2632
+ reduced property implementation to prevent arbitrarily nested implementations.
2633
+ *
2634
+ * Log Safety: UNSAFE
2635
+ */
2636
+ export type NestedInterfacePropertyTypeImplementation = ({
2637
+ type: "structFieldImplementation";
2638
+ } & InterfacePropertyStructFieldImplementation) | ({
2639
+ type: "structImplementation";
2640
+ } & InterfacePropertyStructImplementation) | ({
2641
+ type: "localPropertyImplementation";
2642
+ } & InterfacePropertyLocalPropertyImplementation);
2538
2643
  /**
2539
2644
  * Log Safety: UNSAFE
2540
2645
  */
@@ -2765,6 +2870,14 @@ export interface ObjectEdits {
2765
2870
  addedLinksCount: number;
2766
2871
  deletedLinksCount: number;
2767
2872
  }
2873
+ /**
2874
+ * Optional features to toggle when generating the object loading response.
2875
+ *
2876
+ * Log Safety: SAFE
2877
+ */
2878
+ export interface ObjectLoadingResponseOptions {
2879
+ shouldLoadObjectRids?: boolean;
2880
+ }
2768
2881
  /**
2769
2882
  * An object identifier containing an object type API name and primary key.
2770
2883
  *
@@ -3004,6 +3117,7 @@ export interface ObjectSetStreamSubscribeRequest {
3004
3117
  objectSet: ObjectSet;
3005
3118
  propertySet: Array<SelectedPropertyApiName>;
3006
3119
  referenceSet: Array<SelectedPropertyApiName>;
3120
+ objectLoadingResponseOptions?: ObjectLoadingResponseOptions;
3007
3121
  }
3008
3122
  /**
3009
3123
  * The list of object sets that should be subscribed to. A client can stop subscribing to an object set
@@ -3578,6 +3692,15 @@ export interface PreciseDuration {
3578
3692
  * Log Safety: SAFE
3579
3693
  */
3580
3694
  export type PreciseTimeUnit = "NANOSECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS";
3695
+ /**
3696
+ * Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for
3697
+ the last term. Ordering of the terms in the query is preserved.
3698
+ *
3699
+ * Log Safety: UNSAFE
3700
+ */
3701
+ export interface PrefixOnLastTokenRule {
3702
+ query: string;
3703
+ }
3581
3704
  /**
3582
3705
  * Returns objects where the specified field starts with the provided value.
3583
3706
  *
@@ -4404,6 +4527,8 @@ export type SearchJsonQueryV2 = ({
4404
4527
  } & IsNullQueryV2) | ({
4405
4528
  type: "containsAnyTerm";
4406
4529
  } & ContainsAnyTermQuery) | ({
4530
+ type: "interval";
4531
+ } & IntervalQuery) | ({
4407
4532
  type: "startsWith";
4408
4533
  } & StartsWithQuery);
4409
4534
  /**
@@ -5173,6 +5298,19 @@ export interface UnevaluableConstraint {
5173
5298
  export interface UniqueIdentifierArgument {
5174
5299
  linkId?: string;
5175
5300
  }
5301
+ /**
5302
+ * A reference to a UniqueIdentifierArgument linkId defined for this action type.
5303
+ *
5304
+ * Log Safety: SAFE
5305
+ */
5306
+ export type UniqueIdentifierLinkId = string;
5307
+ /**
5308
+ * An override value to be used for a UniqueIdentifier action parameter, instead of
5309
+ the value being automatically generated.
5310
+ *
5311
+ * Log Safety: SAFE
5312
+ */
5313
+ export type UniqueIdentifierValue = string;
5176
5314
  /**
5177
5315
  * The string must be a valid UUID (Universally Unique Identifier).
5178
5316
  *