@osdk/internal.foundry.ontologiesv2 0.2.0-beta.8 → 0.2.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 (190) hide show
  1. package/CHANGELOG.md +60 -0
  2. package/build/browser/_components.d.ts +4 -0
  3. package/build/browser/_components.d.ts.map +1 -0
  4. package/build/browser/_components.js +17 -0
  5. package/build/browser/_components.js.map +1 -0
  6. package/build/browser/_errors.d.ts +4 -0
  7. package/build/browser/_errors.d.ts.map +1 -0
  8. package/build/browser/_errors.js +17 -0
  9. package/build/browser/_errors.js.map +1 -0
  10. package/build/browser/index.d.ts +17 -0
  11. package/build/browser/index.d.ts.map +1 -0
  12. package/build/browser/index.js +29 -15
  13. package/build/browser/index.js.map +1 -1
  14. package/build/browser/public/Action.d.ts +79 -0
  15. package/build/browser/public/Action.d.ts.map +1 -0
  16. package/build/browser/public/Action.js +78 -3
  17. package/build/browser/public/Action.js.map +1 -1
  18. package/build/browser/public/ActionTypeV2.d.ts +37 -0
  19. package/build/browser/public/ActionTypeV2.d.ts.map +1 -0
  20. package/build/browser/public/ActionTypeV2.js +48 -3
  21. package/build/browser/public/ActionTypeV2.js.map +1 -1
  22. package/build/browser/public/Attachment.d.ts +51 -0
  23. package/build/browser/public/Attachment.d.ts.map +1 -0
  24. package/build/browser/public/Attachment.js +71 -3
  25. package/build/browser/public/Attachment.js.map +1 -1
  26. package/build/browser/public/AttachmentPropertyV2.d.ts +91 -0
  27. package/build/browser/public/AttachmentPropertyV2.d.ts.map +1 -0
  28. package/build/browser/public/AttachmentPropertyV2.js +79 -3
  29. package/build/browser/public/AttachmentPropertyV2.js.map +1 -1
  30. package/build/browser/public/LinkedObjectV2.d.ts +65 -0
  31. package/build/browser/public/LinkedObjectV2.d.ts.map +1 -0
  32. package/build/browser/public/LinkedObjectV2.js +59 -3
  33. package/build/browser/public/LinkedObjectV2.js.map +1 -1
  34. package/build/browser/public/ObjectTypeV2.d.ts +90 -0
  35. package/build/browser/public/ObjectTypeV2.d.ts.map +1 -0
  36. package/build/browser/public/ObjectTypeV2.js +93 -3
  37. package/build/browser/public/ObjectTypeV2.js.map +1 -1
  38. package/build/browser/public/OntologyInterface.d.ts +119 -0
  39. package/build/browser/public/OntologyInterface.d.ts.map +1 -0
  40. package/build/browser/public/OntologyInterface.js +118 -3
  41. package/build/browser/public/OntologyInterface.js.map +1 -1
  42. package/build/browser/public/OntologyObjectSet.d.ts +73 -0
  43. package/build/browser/public/OntologyObjectSet.d.ts.map +1 -0
  44. package/build/browser/public/OntologyObjectSet.js +79 -3
  45. package/build/browser/public/OntologyObjectSet.js.map +1 -1
  46. package/build/browser/public/OntologyObjectV2.d.ts +134 -0
  47. package/build/browser/public/OntologyObjectV2.d.ts.map +1 -0
  48. package/build/browser/public/OntologyObjectV2.js +118 -3
  49. package/build/browser/public/OntologyObjectV2.js.map +1 -1
  50. package/build/browser/public/OntologyV2.d.ts +34 -0
  51. package/build/browser/public/OntologyV2.d.ts.map +1 -0
  52. package/build/browser/public/OntologyV2.js +57 -3
  53. package/build/browser/public/OntologyV2.js.map +1 -1
  54. package/build/browser/public/Query.d.ts +25 -0
  55. package/build/browser/public/Query.d.ts.map +1 -0
  56. package/build/browser/public/Query.js +34 -3
  57. package/build/browser/public/Query.js.map +1 -1
  58. package/build/browser/public/QueryType.d.ts +37 -0
  59. package/build/browser/public/QueryType.d.ts.map +1 -0
  60. package/build/browser/public/QueryType.js +48 -3
  61. package/build/browser/public/QueryType.js.map +1 -1
  62. package/build/browser/public/TimeSeriesPropertyV2.d.ts +67 -0
  63. package/build/browser/public/TimeSeriesPropertyV2.d.ts.map +1 -0
  64. package/build/browser/public/TimeSeriesPropertyV2.js +62 -3
  65. package/build/browser/public/TimeSeriesPropertyV2.js.map +1 -1
  66. package/build/browser/public/TimeSeriesValueBankProperty.d.ts +24 -0
  67. package/build/browser/public/TimeSeriesValueBankProperty.d.ts.map +1 -0
  68. package/build/browser/public/TimeSeriesValueBankProperty.js +33 -0
  69. package/build/browser/public/TimeSeriesValueBankProperty.js.map +1 -0
  70. package/build/esm/_components.js +17 -0
  71. package/build/esm/_components.js.map +1 -0
  72. package/build/esm/_errors.js +17 -0
  73. package/build/esm/_errors.js.map +1 -0
  74. package/build/esm/index.d.ts +1 -0
  75. package/build/esm/index.d.ts.map +1 -1
  76. package/build/esm/index.js +29 -15
  77. package/build/esm/index.js.map +1 -1
  78. package/build/esm/public/Action.d.ts +22 -22
  79. package/build/esm/public/Action.d.ts.map +1 -1
  80. package/build/esm/public/Action.js +78 -3
  81. package/build/esm/public/Action.js.map +1 -1
  82. package/build/esm/public/ActionTypeV2.d.ts +10 -7
  83. package/build/esm/public/ActionTypeV2.d.ts.map +1 -1
  84. package/build/esm/public/ActionTypeV2.js +48 -3
  85. package/build/esm/public/ActionTypeV2.js.map +1 -1
  86. package/build/esm/public/Attachment.d.ts +7 -7
  87. package/build/esm/public/Attachment.d.ts.map +1 -1
  88. package/build/esm/public/Attachment.js +71 -3
  89. package/build/esm/public/Attachment.js.map +1 -1
  90. package/build/esm/public/AttachmentPropertyV2.d.ts +33 -33
  91. package/build/esm/public/AttachmentPropertyV2.d.ts.map +1 -1
  92. package/build/esm/public/AttachmentPropertyV2.js +79 -3
  93. package/build/esm/public/AttachmentPropertyV2.js.map +1 -1
  94. package/build/esm/public/LinkedObjectV2.d.ts +23 -23
  95. package/build/esm/public/LinkedObjectV2.d.ts.map +1 -1
  96. package/build/esm/public/LinkedObjectV2.js +59 -3
  97. package/build/esm/public/LinkedObjectV2.js.map +1 -1
  98. package/build/esm/public/ObjectTypeV2.d.ts +26 -23
  99. package/build/esm/public/ObjectTypeV2.d.ts.map +1 -1
  100. package/build/esm/public/ObjectTypeV2.js +93 -3
  101. package/build/esm/public/ObjectTypeV2.js.map +1 -1
  102. package/build/esm/public/OntologyInterface.d.ts +24 -24
  103. package/build/esm/public/OntologyInterface.d.ts.map +1 -1
  104. package/build/esm/public/OntologyInterface.js +118 -3
  105. package/build/esm/public/OntologyInterface.js.map +1 -1
  106. package/build/esm/public/OntologyObjectSet.d.ts +21 -18
  107. package/build/esm/public/OntologyObjectSet.d.ts.map +1 -1
  108. package/build/esm/public/OntologyObjectSet.js +79 -3
  109. package/build/esm/public/OntologyObjectSet.js.map +1 -1
  110. package/build/esm/public/OntologyObjectV2.d.ts +39 -39
  111. package/build/esm/public/OntologyObjectV2.d.ts.map +1 -1
  112. package/build/esm/public/OntologyObjectV2.js +118 -3
  113. package/build/esm/public/OntologyObjectV2.js.map +1 -1
  114. package/build/esm/public/OntologyV2.d.ts +4 -4
  115. package/build/esm/public/OntologyV2.d.ts.map +1 -1
  116. package/build/esm/public/OntologyV2.js +57 -3
  117. package/build/esm/public/OntologyV2.js.map +1 -1
  118. package/build/esm/public/Query.d.ts +8 -8
  119. package/build/esm/public/Query.d.ts.map +1 -1
  120. package/build/esm/public/Query.js +34 -3
  121. package/build/esm/public/Query.js.map +1 -1
  122. package/build/esm/public/QueryType.d.ts +10 -7
  123. package/build/esm/public/QueryType.d.ts.map +1 -1
  124. package/build/esm/public/QueryType.js +48 -3
  125. package/build/esm/public/QueryType.js.map +1 -1
  126. package/build/esm/public/TimeSeriesPropertyV2.d.ts +22 -22
  127. package/build/esm/public/TimeSeriesPropertyV2.d.ts.map +1 -1
  128. package/build/esm/public/TimeSeriesPropertyV2.js +62 -3
  129. package/build/esm/public/TimeSeriesPropertyV2.js.map +1 -1
  130. package/build/esm/public/TimeSeriesValueBankProperty.d.ts +24 -0
  131. package/build/esm/public/TimeSeriesValueBankProperty.d.ts.map +1 -0
  132. package/build/esm/public/TimeSeriesValueBankProperty.js +33 -0
  133. package/build/esm/public/TimeSeriesValueBankProperty.js.map +1 -0
  134. package/package.json +8 -9
  135. package/build/browser/chunk-35VM6XLH.js +0 -26
  136. package/build/browser/chunk-35VM6XLH.js.map +0 -1
  137. package/build/browser/chunk-3H3SHEFA.js +0 -31
  138. package/build/browser/chunk-3H3SHEFA.js.map +0 -1
  139. package/build/browser/chunk-4TOWICL3.js +0 -21
  140. package/build/browser/chunk-4TOWICL3.js.map +0 -1
  141. package/build/browser/chunk-A2ZEBCGI.js +0 -26
  142. package/build/browser/chunk-A2ZEBCGI.js.map +0 -1
  143. package/build/browser/chunk-CTA4DXZF.js +0 -31
  144. package/build/browser/chunk-CTA4DXZF.js.map +0 -1
  145. package/build/browser/chunk-EFVOGNPX.js +0 -31
  146. package/build/browser/chunk-EFVOGNPX.js.map +0 -1
  147. package/build/browser/chunk-GWYI4RKT.js +0 -21
  148. package/build/browser/chunk-GWYI4RKT.js.map +0 -1
  149. package/build/browser/chunk-KQNF55S5.js +0 -26
  150. package/build/browser/chunk-KQNF55S5.js.map +0 -1
  151. package/build/browser/chunk-OBKC7XBM.js +0 -31
  152. package/build/browser/chunk-OBKC7XBM.js.map +0 -1
  153. package/build/browser/chunk-PZ5AY32C.js +0 -9
  154. package/build/browser/chunk-PZ5AY32C.js.map +0 -1
  155. package/build/browser/chunk-U76D6BOW.js +0 -36
  156. package/build/browser/chunk-U76D6BOW.js.map +0 -1
  157. package/build/browser/chunk-UFJTKRQC.js +0 -16
  158. package/build/browser/chunk-UFJTKRQC.js.map +0 -1
  159. package/build/browser/chunk-VCCTOHYG.js +0 -21
  160. package/build/browser/chunk-VCCTOHYG.js.map +0 -1
  161. package/build/browser/chunk-ZNHKEV4X.js +0 -36
  162. package/build/browser/chunk-ZNHKEV4X.js.map +0 -1
  163. package/build/esm/chunk-35VM6XLH.js +0 -26
  164. package/build/esm/chunk-35VM6XLH.js.map +0 -1
  165. package/build/esm/chunk-3H3SHEFA.js +0 -31
  166. package/build/esm/chunk-3H3SHEFA.js.map +0 -1
  167. package/build/esm/chunk-4TOWICL3.js +0 -21
  168. package/build/esm/chunk-4TOWICL3.js.map +0 -1
  169. package/build/esm/chunk-A2ZEBCGI.js +0 -26
  170. package/build/esm/chunk-A2ZEBCGI.js.map +0 -1
  171. package/build/esm/chunk-CTA4DXZF.js +0 -31
  172. package/build/esm/chunk-CTA4DXZF.js.map +0 -1
  173. package/build/esm/chunk-EFVOGNPX.js +0 -31
  174. package/build/esm/chunk-EFVOGNPX.js.map +0 -1
  175. package/build/esm/chunk-GWYI4RKT.js +0 -21
  176. package/build/esm/chunk-GWYI4RKT.js.map +0 -1
  177. package/build/esm/chunk-KQNF55S5.js +0 -26
  178. package/build/esm/chunk-KQNF55S5.js.map +0 -1
  179. package/build/esm/chunk-OBKC7XBM.js +0 -31
  180. package/build/esm/chunk-OBKC7XBM.js.map +0 -1
  181. package/build/esm/chunk-PZ5AY32C.js +0 -9
  182. package/build/esm/chunk-PZ5AY32C.js.map +0 -1
  183. package/build/esm/chunk-U76D6BOW.js +0 -36
  184. package/build/esm/chunk-U76D6BOW.js.map +0 -1
  185. package/build/esm/chunk-UFJTKRQC.js +0 -16
  186. package/build/esm/chunk-UFJTKRQC.js.map +0 -1
  187. package/build/esm/chunk-VCCTOHYG.js +0 -21
  188. package/build/esm/chunk-VCCTOHYG.js.map +0 -1
  189. package/build/esm/chunk-ZNHKEV4X.js +0 -36
  190. package/build/esm/chunk-ZNHKEV4X.js.map +0 -1
@@ -0,0 +1,119 @@
1
+ import type * as _Core from "@osdk/internal.foundry.core";
2
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
3
+ /**
4
+ * :::callout{theme=warning title=Warning}
5
+ * This endpoint is in preview and may be modified or removed at any time.
6
+ * To use this endpoint, add `preview=true` to the request query parameters.
7
+ * :::
8
+ *
9
+ * Lists the interface types for the given Ontology.
10
+ *
11
+ * Each page may be smaller than the requested page size. However, it is guaranteed that if there are more
12
+ * results available, at least one result will be present in the response.
13
+ *
14
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
15
+ *
16
+ * @alpha
17
+ *
18
+ * Required Scopes: [api:ontologies-read]
19
+ * URL: /v2/ontologies/{ontology}/interfaceTypes
20
+ */
21
+ export declare function list($ctx: $Client | $ClientContext, ...args: [
22
+ ontology: _Core.OntologyIdentifier,
23
+ $queryParams?: {
24
+ pageSize?: _Core.PageSize | undefined;
25
+ pageToken?: _Core.PageToken | undefined;
26
+ preview?: _Core.PreviewMode | undefined;
27
+ }
28
+ ]): Promise<_Core.ListInterfaceTypesResponse>;
29
+ /**
30
+ * :::callout{theme=warning title=Warning}
31
+ * This endpoint is in preview and may be modified or removed at any time.
32
+ * To use this endpoint, add `preview=true` to the request query parameters.
33
+ * :::
34
+ *
35
+ * Gets a specific object type with the given API name.
36
+ *
37
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
38
+ *
39
+ * @alpha
40
+ *
41
+ * Required Scopes: [api:ontologies-read]
42
+ * URL: /v2/ontologies/{ontology}/interfaceTypes/{interfaceType}
43
+ */
44
+ export declare function get($ctx: $Client | $ClientContext, ...args: [
45
+ ontology: _Core.OntologyIdentifier,
46
+ interfaceType: _Core.InterfaceTypeApiName,
47
+ $queryParams?: {
48
+ preview?: _Core.PreviewMode | undefined;
49
+ }
50
+ ]): Promise<_Core.InterfaceType>;
51
+ /**
52
+ * :::callout{theme=warning title=Warning}
53
+ * This endpoint is in preview and may be modified or removed at any time.
54
+ * To use this endpoint, add `preview=true` to the request query parameters.
55
+ * :::
56
+ *
57
+ * Search for objects in the specified ontology and interface type. Any properties specified in the "where" or
58
+ * "orderBy" parameters must be shared property type API names defined on the interface. The following search
59
+ * queries are supported:
60
+ *
61
+ * | Query type | Description | Supported Types |
62
+ * |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|
63
+ * | lt | The provided property is less than the provided value. | number, string, date, timestamp |
64
+ * | gt | The provided property is greater than the provided value. | number, string, date, timestamp |
65
+ * | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |
66
+ * | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |
67
+ * | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |
68
+ * | isNull | The provided property is (or is not) null. | all |
69
+ * | contains | The provided property contains the provided value. | array |
70
+ * | not | The sub-query does not match. | N/A (applied on a query) |
71
+ * | and | All the sub-queries match. | N/A (applied on queries) |
72
+ * | or | At least one of the sub-queries match. | N/A (applied on queries) |
73
+ * | startsWith | The provided property starts with the provided value. | string |
74
+ * | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |
75
+ * | containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |
76
+ * | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |
77
+ * | containsAllTerms | The provided property contains all the terms separated by whitespace. | string |
78
+ *
79
+ * Attempting to use an unsupported query will result in a validation error. Third-party applications using this
80
+ * endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
81
+ *
82
+ * @alpha
83
+ *
84
+ * Required Scopes: [api:ontologies-read]
85
+ * URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/search
86
+ */
87
+ export declare function search($ctx: $Client | $ClientContext, ...args: [
88
+ ontology: _Core.OntologyIdentifier,
89
+ interfaceType: _Core.InterfaceTypeApiName,
90
+ $body: _Core.SearchObjectsForInterfaceRequest,
91
+ $queryParams?: {
92
+ preview?: _Core.PreviewMode | undefined;
93
+ }
94
+ ]): Promise<_Core.SearchObjectsResponseV2>;
95
+ /**
96
+ * :::callout{theme=warning title=Warning}
97
+ * This endpoint is in preview and may be modified or removed at any time.
98
+ * To use this endpoint, add `preview=true` to the request query parameters.
99
+ * :::
100
+ *
101
+ * Perform functions on object fields in the specified ontology and of the specified interface type. Any
102
+ * properties specified in the query must be shared property type API names defined on the interface.
103
+ *
104
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
105
+ *
106
+ * @alpha
107
+ *
108
+ * Required Scopes: [api:ontologies-read]
109
+ * URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate
110
+ */
111
+ export declare function aggregate($ctx: $Client | $ClientContext, ...args: [
112
+ ontology: _Core.OntologyIdentifier,
113
+ interfaceType: _Core.InterfaceTypeApiName,
114
+ $body: _Core.AggregateObjectsRequestV2,
115
+ $queryParams?: {
116
+ preview?: _Core.PreviewMode | undefined;
117
+ }
118
+ ]): Promise<_Core.AggregateObjectsResponseV2>;
119
+ //# sourceMappingURL=OntologyInterface.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OntologyInterface.d.ts","sourceRoot":"","sources":["../../../src/public/OntologyInterface.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,qBAAqB,CAAC;AAiB7B;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAElC,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QACtC,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QACxC,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAE3C;AAUD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,aAAa,EAAE,KAAK,CAAC,oBAAoB;IAEzC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAE9B;AAWD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,aAAa,EAAE,KAAK,CAAC,oBAAoB;IACzC,KAAK,EAAE,KAAK,CAAC,gCAAgC;IAC7C,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAExC;AAWD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,aAAa,EAAE,KAAK,CAAC,oBAAoB;IACzC,KAAK,EAAE,KAAK,CAAC,yBAAyB;IACtC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAE3C"}
@@ -1,4 +1,119 @@
1
- export { aggregateObjectsForInterface, getInterfaceType, listInterfaceTypes, searchObjectsForInterface } from '../chunk-OBKC7XBM.js';
2
- import '../chunk-PZ5AY32C.js';
3
- //# sourceMappingURL=OntologyInterface.js.map
1
+ /*
2
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
17
+ //
18
+ const _list = [0, "/v2/ontologies/{0}/interfaceTypes", 2];
19
+ /**
20
+ * :::callout{theme=warning title=Warning}
21
+ * This endpoint is in preview and may be modified or removed at any time.
22
+ * To use this endpoint, add `preview=true` to the request query parameters.
23
+ * :::
24
+ *
25
+ * Lists the interface types for the given Ontology.
26
+ *
27
+ * Each page may be smaller than the requested page size. However, it is guaranteed that if there are more
28
+ * results available, at least one result will be present in the response.
29
+ *
30
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
31
+ *
32
+ * @alpha
33
+ *
34
+ * Required Scopes: [api:ontologies-read]
35
+ * URL: /v2/ontologies/{ontology}/interfaceTypes
36
+ */
37
+ export function list($ctx, ...args) {
38
+ return $foundryPlatformFetch($ctx, _list, ...args);
39
+ }
40
+ const _get = [0, "/v2/ontologies/{0}/interfaceTypes/{1}", 2];
41
+ /**
42
+ * :::callout{theme=warning title=Warning}
43
+ * This endpoint is in preview and may be modified or removed at any time.
44
+ * To use this endpoint, add `preview=true` to the request query parameters.
45
+ * :::
46
+ *
47
+ * Gets a specific object type with the given API name.
48
+ *
49
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
50
+ *
51
+ * @alpha
52
+ *
53
+ * Required Scopes: [api:ontologies-read]
54
+ * URL: /v2/ontologies/{ontology}/interfaceTypes/{interfaceType}
55
+ */
56
+ export function get($ctx, ...args) {
57
+ return $foundryPlatformFetch($ctx, _get, ...args);
58
+ }
59
+ const _search = [1, "/v2/ontologies/{0}/interfaces/{1}/search", 3];
60
+ /**
61
+ * :::callout{theme=warning title=Warning}
62
+ * This endpoint is in preview and may be modified or removed at any time.
63
+ * To use this endpoint, add `preview=true` to the request query parameters.
64
+ * :::
65
+ *
66
+ * Search for objects in the specified ontology and interface type. Any properties specified in the "where" or
67
+ * "orderBy" parameters must be shared property type API names defined on the interface. The following search
68
+ * queries are supported:
69
+ *
70
+ * | Query type | Description | Supported Types |
71
+ * |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|
72
+ * | lt | The provided property is less than the provided value. | number, string, date, timestamp |
73
+ * | gt | The provided property is greater than the provided value. | number, string, date, timestamp |
74
+ * | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |
75
+ * | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |
76
+ * | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |
77
+ * | isNull | The provided property is (or is not) null. | all |
78
+ * | contains | The provided property contains the provided value. | array |
79
+ * | not | The sub-query does not match. | N/A (applied on a query) |
80
+ * | and | All the sub-queries match. | N/A (applied on queries) |
81
+ * | or | At least one of the sub-queries match. | N/A (applied on queries) |
82
+ * | startsWith | The provided property starts with the provided value. | string |
83
+ * | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |
84
+ * | containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |
85
+ * | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |
86
+ * | containsAllTerms | The provided property contains all the terms separated by whitespace. | string |
87
+ *
88
+ * Attempting to use an unsupported query will result in a validation error. Third-party applications using this
89
+ * endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
90
+ *
91
+ * @alpha
92
+ *
93
+ * Required Scopes: [api:ontologies-read]
94
+ * URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/search
95
+ */
96
+ export function search($ctx, ...args) {
97
+ return $foundryPlatformFetch($ctx, _search, ...args);
98
+ }
99
+ const _aggregate = [1, "/v2/ontologies/{0}/interfaces/{1}/aggregate", 3];
100
+ /**
101
+ * :::callout{theme=warning title=Warning}
102
+ * This endpoint is in preview and may be modified or removed at any time.
103
+ * To use this endpoint, add `preview=true` to the request query parameters.
104
+ * :::
105
+ *
106
+ * Perform functions on object fields in the specified ontology and of the specified interface type. Any
107
+ * properties specified in the query must be shared property type API names defined on the interface.
108
+ *
109
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
110
+ *
111
+ * @alpha
112
+ *
113
+ * Required Scopes: [api:ontologies-read]
114
+ * URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate
115
+ */
116
+ export function aggregate($ctx, ...args) {
117
+ return $foundryPlatformFetch($ctx, _aggregate, ...args);
118
+ }
4
119
  //# sourceMappingURL=OntologyInterface.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":[],"names":[],"mappings":"","file":"OntologyInterface.js"}
1
+ {"version":3,"file":"OntologyInterface.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_list","list","$ctx","args","_get","get","_search","search","_aggregate","aggregate"],"sources":["OntologyInterface.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _list = [0, \"/v2/ontologies/{0}/interfaceTypes\", 2];\n/**\n * :::callout{theme=warning title=Warning}\n * This endpoint is in preview and may be modified or removed at any time.\n * To use this endpoint, add `preview=true` to the request query parameters.\n * :::\n *\n * Lists the interface types for the given Ontology.\n *\n * Each page may be smaller than the requested page size. However, it is guaranteed that if there are more\n * results available, at least one result will be present in the response.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @alpha\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/interfaceTypes\n */\nexport function list($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _list, ...args);\n}\nconst _get = [0, \"/v2/ontologies/{0}/interfaceTypes/{1}\", 2];\n/**\n * :::callout{theme=warning title=Warning}\n * This endpoint is in preview and may be modified or removed at any time.\n * To use this endpoint, add `preview=true` to the request query parameters.\n * :::\n *\n * Gets a specific object type with the given API name.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @alpha\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/interfaceTypes/{interfaceType}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _search = [1, \"/v2/ontologies/{0}/interfaces/{1}/search\", 3];\n/**\n * :::callout{theme=warning title=Warning}\n * This endpoint is in preview and may be modified or removed at any time.\n * To use this endpoint, add `preview=true` to the request query parameters.\n * :::\n *\n * Search for objects in the specified ontology and interface type. Any properties specified in the \"where\" or\n * \"orderBy\" parameters must be shared property type API names defined on the interface. The following search\n * queries are supported:\n *\n * | Query type | Description | Supported Types |\n * |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|\n * | lt | The provided property is less than the provided value. | number, string, date, timestamp |\n * | gt | The provided property is greater than the provided value. | number, string, date, timestamp |\n * | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |\n * | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |\n * | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |\n * | isNull | The provided property is (or is not) null. | all |\n * | contains | The provided property contains the provided value. | array |\n * | not | The sub-query does not match. | N/A (applied on a query) |\n * | and | All the sub-queries match. | N/A (applied on queries) |\n * | or | At least one of the sub-queries match. | N/A (applied on queries) |\n * | startsWith | The provided property starts with the provided value. | string |\n * | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |\n * | containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |\n * | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n * | containsAllTerms | The provided property contains all the terms separated by whitespace. | string |\n *\n * Attempting to use an unsupported query will result in a validation error. Third-party applications using this\n * endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @alpha\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/search\n */\nexport function search($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _search, ...args);\n}\nconst _aggregate = [1, \"/v2/ontologies/{0}/interfaces/{1}/aggregate\", 3];\n/**\n * :::callout{theme=warning title=Warning}\n * This endpoint is in preview and may be modified or removed at any time.\n * To use this endpoint, add `preview=true` to the request query parameters.\n * :::\n *\n * Perform functions on object fields in the specified ontology and of the specified interface type. Any\n * properties specified in the query must be shared property type API names defined on the interface.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @alpha\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate\n */\nexport function aggregate($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _aggregate, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,KAAK,GAAG,CAAC,CAAC,EAAE,mCAAmC,EAAE,CAAC,CAAC;AACzD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,IAAIA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAChC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,KAAK,EAAE,GAAGG,IAAI,CAAC;AACtD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,uCAAuC,EAAE,CAAC,CAAC;AAC5D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD;AACA,MAAMG,OAAO,GAAG,CAAC,CAAC,EAAE,0CAA0C,EAAE,CAAC,CAAC;AAClE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,OAAO,EAAE,GAAGH,IAAI,CAAC;AACxD;AACA,MAAMK,UAAU,GAAG,CAAC,CAAC,EAAE,6CAA6C,EAAE,CAAC,CAAC;AACxE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACrC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,UAAU,EAAE,GAAGL,IAAI,CAAC;AAC3D","ignoreList":[]}
@@ -0,0 +1,73 @@
1
+ import type * as _Core from "@osdk/internal.foundry.core";
2
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
3
+ /**
4
+ * Creates a temporary `ObjectSet` from the given definition.
5
+ *
6
+ * Third-party applications using this endpoint via OAuth2 must request the
7
+ * following operation scopes: `api:ontologies-read api:ontologies-write`.
8
+ *
9
+ * @alpha
10
+ *
11
+ * Required Scopes: [api:ontologies-read, api:ontologies-write]
12
+ * URL: /v2/ontologies/{ontology}/objectSets/createTemporary
13
+ */
14
+ export declare function createTemporary($ctx: $Client | $ClientContext, ...args: [
15
+ ontology: _Core.OntologyIdentifier,
16
+ $body: _Core.CreateTemporaryObjectSetRequestV2
17
+ ]): Promise<_Core.CreateTemporaryObjectSetResponseV2>;
18
+ /**
19
+ * Gets the definition of the `ObjectSet` with the given RID.
20
+ *
21
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
22
+ *
23
+ * @alpha
24
+ *
25
+ * Required Scopes: []
26
+ * URL: /v2/ontologies/{ontology}/objectSets/{objectSetRid}
27
+ */
28
+ export declare function get($ctx: $Client | $ClientContext, ...args: [
29
+ ontology: _Core.OntologyIdentifier,
30
+ objectSetRid: _Core.ObjectSetRid
31
+ ]): Promise<_Core.ObjectSet>;
32
+ /**
33
+ * Load the ontology objects present in the `ObjectSet` from the provided object set definition.
34
+ *
35
+ * For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
36
+ * are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.
37
+ *
38
+ * Note that null value properties will not be returned.
39
+ *
40
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
41
+ *
42
+ * @public
43
+ *
44
+ * Required Scopes: [api:ontologies-read]
45
+ * URL: /v2/ontologies/{ontology}/objectSets/loadObjects
46
+ */
47
+ export declare function load($ctx: $Client | $ClientContext, ...args: [
48
+ ontology: _Core.OntologyIdentifier,
49
+ $body: _Core.LoadObjectSetRequestV2,
50
+ $queryParams?: {
51
+ artifactRepository?: _Core.ArtifactRepositoryRid | undefined;
52
+ packageName?: _Core.SdkPackageName | undefined;
53
+ }
54
+ ]): Promise<_Core.LoadObjectSetResponseV2>;
55
+ /**
56
+ * Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition.
57
+ *
58
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
59
+ *
60
+ * @public
61
+ *
62
+ * Required Scopes: [api:ontologies-read]
63
+ * URL: /v2/ontologies/{ontology}/objectSets/aggregate
64
+ */
65
+ export declare function aggregate($ctx: $Client | $ClientContext, ...args: [
66
+ ontology: _Core.OntologyIdentifier,
67
+ $body: _Core.AggregateObjectSetRequestV2,
68
+ $queryParams?: {
69
+ artifactRepository?: _Core.ArtifactRepositoryRid | undefined;
70
+ packageName?: _Core.SdkPackageName | undefined;
71
+ }
72
+ ]): Promise<_Core.AggregateObjectsResponseV2>;
73
+ //# sourceMappingURL=OntologyObjectSet.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OntologyObjectSet.d.ts","sourceRoot":"","sources":["../../../src/public/OntologyObjectSet.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,qBAAqB,CAAC;AAa7B;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,KAAK,EAAE,KAAK,CAAC,iCAAiC;CAC/C,GACA,OAAO,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAEnD;AASD;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,YAAY,EAAE,KAAK,CAAC,YAAY;CACjC,GACA,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAE1B;AAaD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,KAAK,EAAE,KAAK,CAAC,sBAAsB;IACnC,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,KAAK,CAAC,qBAAqB,GAAG,SAAS,CAAC;QAC7D,WAAW,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;KAChD;CACF,GACA,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAExC;AAaD;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,KAAK,EAAE,KAAK,CAAC,2BAA2B;IACxC,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,KAAK,CAAC,qBAAqB,GAAG,SAAS,CAAC;QAC7D,WAAW,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;KAChD;CACF,GACA,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAE3C"}
@@ -1,4 +1,80 @@
1
- export { aggregateObjectSetV2, createTemporaryObjectSetV2, getObjectSetV2, loadObjectSetV2 } from '../chunk-CTA4DXZF.js';
2
- import '../chunk-PZ5AY32C.js';
3
- //# sourceMappingURL=OntologyObjectSet.js.map
1
+ /*
2
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
17
+ //
18
+ const _createTemporary = [1, "/v2/ontologies/{0}/objectSets/createTemporary", 1];
19
+ /**
20
+ * Creates a temporary `ObjectSet` from the given definition.
21
+ *
22
+ * Third-party applications using this endpoint via OAuth2 must request the
23
+ * following operation scopes: `api:ontologies-read api:ontologies-write`.
24
+ *
25
+ * @alpha
26
+ *
27
+ * Required Scopes: [api:ontologies-read, api:ontologies-write]
28
+ * URL: /v2/ontologies/{ontology}/objectSets/createTemporary
29
+ */
30
+ export function createTemporary($ctx, ...args) {
31
+ return $foundryPlatformFetch($ctx, _createTemporary, ...args);
32
+ }
33
+ const _get = [0, "/v2/ontologies/{0}/objectSets/{1}"];
34
+ /**
35
+ * Gets the definition of the `ObjectSet` with the given RID.
36
+ *
37
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
38
+ *
39
+ * @alpha
40
+ *
41
+ * Required Scopes: []
42
+ * URL: /v2/ontologies/{ontology}/objectSets/{objectSetRid}
43
+ */
44
+ export function get($ctx, ...args) {
45
+ return $foundryPlatformFetch($ctx, _get, ...args);
46
+ }
47
+ const _load = [1, "/v2/ontologies/{0}/objectSets/loadObjects", 3];
48
+ /**
49
+ * Load the ontology objects present in the `ObjectSet` from the provided object set definition.
50
+ *
51
+ * For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
52
+ * are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.
53
+ *
54
+ * Note that null value properties will not be returned.
55
+ *
56
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
57
+ *
58
+ * @public
59
+ *
60
+ * Required Scopes: [api:ontologies-read]
61
+ * URL: /v2/ontologies/{ontology}/objectSets/loadObjects
62
+ */
63
+ export function load($ctx, ...args) {
64
+ return $foundryPlatformFetch($ctx, _load, ...args);
65
+ }
66
+ const _aggregate = [1, "/v2/ontologies/{0}/objectSets/aggregate", 3];
67
+ /**
68
+ * Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition.
69
+ *
70
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
71
+ *
72
+ * @public
73
+ *
74
+ * Required Scopes: [api:ontologies-read]
75
+ * URL: /v2/ontologies/{ontology}/objectSets/aggregate
76
+ */
77
+ export function aggregate($ctx, ...args) {
78
+ return $foundryPlatformFetch($ctx, _aggregate, ...args);
79
+ }
4
80
  //# sourceMappingURL=OntologyObjectSet.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":[],"names":[],"mappings":"","file":"OntologyObjectSet.js"}
1
+ {"version":3,"file":"OntologyObjectSet.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_createTemporary","createTemporary","$ctx","args","_get","get","_load","load","_aggregate","aggregate"],"sources":["OntologyObjectSet.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _createTemporary = [1, \"/v2/ontologies/{0}/objectSets/createTemporary\", 1];\n/**\n * Creates a temporary `ObjectSet` from the given definition.\n *\n * Third-party applications using this endpoint via OAuth2 must request the\n * following operation scopes: `api:ontologies-read api:ontologies-write`.\n *\n * @alpha\n *\n * Required Scopes: [api:ontologies-read, api:ontologies-write]\n * URL: /v2/ontologies/{ontology}/objectSets/createTemporary\n */\nexport function createTemporary($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _createTemporary, ...args);\n}\nconst _get = [0, \"/v2/ontologies/{0}/objectSets/{1}\"];\n/**\n * Gets the definition of the `ObjectSet` with the given RID.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @alpha\n *\n * Required Scopes: []\n * URL: /v2/ontologies/{ontology}/objectSets/{objectSetRid}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _load = [1, \"/v2/ontologies/{0}/objectSets/loadObjects\", 3];\n/**\n * Load the ontology objects present in the `ObjectSet` from the provided object set definition.\n *\n * For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects\n * are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n *\n * Note that null value properties will not be returned.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectSets/loadObjects\n */\nexport function load($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _load, ...args);\n}\nconst _aggregate = [1, \"/v2/ontologies/{0}/objectSets/aggregate\", 3];\n/**\n * Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectSets/aggregate\n */\nexport function aggregate($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _aggregate, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,gBAAgB,GAAG,CAAC,CAAC,EAAE,+CAA+C,EAAE,CAAC,CAAC;AAChF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC3C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,gBAAgB,EAAE,GAAGG,IAAI,CAAC;AACjE;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,mCAAmC,CAAC;AACrD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD;AACA,MAAMG,KAAK,GAAG,CAAC,CAAC,EAAE,2CAA2C,EAAE,CAAC,CAAC;AACjE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,IAAIA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EAChC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,KAAK,EAAE,GAAGH,IAAI,CAAC;AACtD;AACA,MAAMK,UAAU,GAAG,CAAC,CAAC,EAAE,yCAAyC,EAAE,CAAC,CAAC;AACpE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACrC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,UAAU,EAAE,GAAGL,IAAI,CAAC;AAC3D","ignoreList":[]}
@@ -0,0 +1,134 @@
1
+ import type * as _Core from "@osdk/internal.foundry.core";
2
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
3
+ /**
4
+ * Lists the objects for the given Ontology and object type.
5
+ *
6
+ * Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or
7
+ * repeated objects in the response pages.
8
+ *
9
+ * For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
10
+ * are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.
11
+ *
12
+ * Each page may be smaller or larger than the requested page size. However, it
13
+ * is guaranteed that if there are more results available, at least one result will be present
14
+ * in the response.
15
+ *
16
+ * Note that null value properties will not be returned.
17
+ *
18
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
19
+ *
20
+ * @public
21
+ *
22
+ * Required Scopes: [api:ontologies-read]
23
+ * URL: /v2/ontologies/{ontology}/objects/{objectType}
24
+ */
25
+ export declare function list($ctx: $Client | $ClientContext, ...args: [
26
+ ontology: _Core.OntologyIdentifier,
27
+ objectType: _Core.ObjectTypeApiName,
28
+ $queryParams: {
29
+ pageSize?: _Core.PageSize | undefined;
30
+ pageToken?: _Core.PageToken | undefined;
31
+ select: Array<_Core.SelectedPropertyApiName>;
32
+ orderBy?: _Core.OrderBy | undefined;
33
+ artifactRepository?: _Core.ArtifactRepositoryRid | undefined;
34
+ packageName?: _Core.SdkPackageName | undefined;
35
+ excludeRid?: boolean | undefined;
36
+ }
37
+ ]): Promise<_Core.ListObjectsResponseV2>;
38
+ /**
39
+ * Gets a specific object with the given primary key.
40
+ *
41
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
42
+ *
43
+ * @public
44
+ *
45
+ * Required Scopes: [api:ontologies-read]
46
+ * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}
47
+ */
48
+ export declare function get($ctx: $Client | $ClientContext, ...args: [
49
+ ontology: _Core.OntologyIdentifier,
50
+ objectType: _Core.ObjectTypeApiName,
51
+ primaryKey: _Core.PropertyValueEscapedString,
52
+ $queryParams: {
53
+ select: Array<_Core.SelectedPropertyApiName>;
54
+ artifactRepository?: _Core.ArtifactRepositoryRid | undefined;
55
+ packageName?: _Core.SdkPackageName | undefined;
56
+ excludeRid?: boolean | undefined;
57
+ }
58
+ ]): Promise<_Core.OntologyObjectV2>;
59
+ /**
60
+ * Returns a count of the objects of the given object type.
61
+ *
62
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
63
+ *
64
+ * @alpha
65
+ *
66
+ * Required Scopes: [api:ontologies-read]
67
+ * URL: /v2/ontologies/{ontology}/objects/{objectType}/count
68
+ */
69
+ export declare function count($ctx: $Client | $ClientContext, ...args: [
70
+ ontology: _Core.OntologyIdentifier,
71
+ objectType: _Core.ObjectTypeApiName,
72
+ $queryParams?: {
73
+ artifactRepository?: _Core.ArtifactRepositoryRid | undefined;
74
+ packageName?: _Core.SdkPackageName | undefined;
75
+ }
76
+ ]): Promise<_Core.CountObjectsResponseV2>;
77
+ /**
78
+ * Search for objects in the specified ontology and object type. The request body is used
79
+ * to filter objects based on the specified query. The supported queries are:
80
+ *
81
+ * | Query type | Description | Supported Types |
82
+ * |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|
83
+ * | lt | The provided property is less than the provided value. | number, string, date, timestamp |
84
+ * | gt | The provided property is greater than the provided value. | number, string, date, timestamp |
85
+ * | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |
86
+ * | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |
87
+ * | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |
88
+ * | isNull | The provided property is (or is not) null. | all |
89
+ * | contains | The provided property contains the provided value. | array |
90
+ * | not | The sub-query does not match. | N/A (applied on a query) |
91
+ * | and | All the sub-queries match. | N/A (applied on queries) |
92
+ * | or | At least one of the sub-queries match. | N/A (applied on queries) |
93
+ * | startsWith | The provided property starts with the provided value. | string |
94
+ * | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |
95
+ * | containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |
96
+ * | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |
97
+ * | containsAllTerms | The provided property contains all the terms separated by whitespace. | string |
98
+ *
99
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
100
+ *
101
+ * @public
102
+ *
103
+ * Required Scopes: [api:ontologies-read]
104
+ * URL: /v2/ontologies/{ontology}/objects/{objectType}/search
105
+ */
106
+ export declare function search($ctx: $Client | $ClientContext, ...args: [
107
+ ontology: _Core.OntologyIdentifier,
108
+ objectType: _Core.ObjectTypeApiName,
109
+ $body: _Core.SearchObjectsRequestV2,
110
+ $queryParams?: {
111
+ artifactRepository?: _Core.ArtifactRepositoryRid | undefined;
112
+ packageName?: _Core.SdkPackageName | undefined;
113
+ }
114
+ ]): Promise<_Core.SearchObjectsResponseV2>;
115
+ /**
116
+ * Perform functions on object fields in the specified ontology and object type.
117
+ *
118
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
119
+ *
120
+ * @public
121
+ *
122
+ * Required Scopes: [api:ontologies-read]
123
+ * URL: /v2/ontologies/{ontology}/objects/{objectType}/aggregate
124
+ */
125
+ export declare function aggregate($ctx: $Client | $ClientContext, ...args: [
126
+ ontology: _Core.OntologyIdentifier,
127
+ objectType: _Core.ObjectTypeApiName,
128
+ $body: _Core.AggregateObjectsRequestV2,
129
+ $queryParams?: {
130
+ artifactRepository?: _Core.ArtifactRepositoryRid | undefined;
131
+ packageName?: _Core.SdkPackageName | undefined;
132
+ }
133
+ ]): Promise<_Core.AggregateObjectsResponseV2>;
134
+ //# sourceMappingURL=OntologyObjectV2.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OntologyObjectV2.d.ts","sourceRoot":"","sources":["../../../src/public/OntologyObjectV2.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,qBAAqB,CAAC;AAsB7B;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,UAAU,EAAE,KAAK,CAAC,iBAAiB;IAEnC,YAAY,EAAE;QACZ,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QACtC,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QACxC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC7C,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;QACpC,kBAAkB,CAAC,EAAE,KAAK,CAAC,qBAAqB,GAAG,SAAS,CAAC;QAC7D,WAAW,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;QAC/C,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAClC;CACF,GACA,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAEtC;AAgBD;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,UAAU,EAAE,KAAK,CAAC,iBAAiB;IACnC,UAAU,EAAE,KAAK,CAAC,0BAA0B;IAE5C,YAAY,EAAE;QACZ,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC7C,kBAAkB,CAAC,EAAE,KAAK,CAAC,qBAAqB,GAAG,SAAS,CAAC;QAC7D,WAAW,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;QAC/C,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAClC;CACF,GACA,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAEjC;AAaD;;;;;;;;;GASG;AACH,wBAAgB,KAAK,CACnB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,UAAU,EAAE,KAAK,CAAC,iBAAiB;IAEnC,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,KAAK,CAAC,qBAAqB,GAAG,SAAS,CAAC;QAC7D,WAAW,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;KAChD;CACF,GACA,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAEvC;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,UAAU,EAAE,KAAK,CAAC,iBAAiB;IACnC,KAAK,EAAE,KAAK,CAAC,sBAAsB;IACnC,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,KAAK,CAAC,qBAAqB,GAAG,SAAS,CAAC;QAC7D,WAAW,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;KAChD;CACF,GACA,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAExC;AAcD;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,KAAK,CAAC,kBAAkB;IAClC,UAAU,EAAE,KAAK,CAAC,iBAAiB;IACnC,KAAK,EAAE,KAAK,CAAC,yBAAyB;IACtC,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,KAAK,CAAC,qBAAqB,GAAG,SAAS,CAAC;QAC7D,WAAW,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;KAChD;CACF,GACA,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAE3C"}