@aventurevc/api-schemas 0.7.301 → 0.7.328

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 (423) hide show
  1. package/README.md +7 -1
  2. package/dist/address/address.d.ts +1 -8
  3. package/dist/address/address.js +1 -8
  4. package/dist/address/association-role.d.ts +1 -8
  5. package/dist/address/association-role.js +1 -8
  6. package/dist/address/association.d.ts +1 -8
  7. package/dist/address/association.js +1 -8
  8. package/dist/address/city.d.ts +1 -8
  9. package/dist/address/city.js +1 -8
  10. package/dist/address/country.d.ts +1 -8
  11. package/dist/address/country.js +1 -8
  12. package/dist/address/state.d.ts +1 -8
  13. package/dist/address/state.js +1 -8
  14. package/dist/agent/help-question.d.ts +1 -0
  15. package/dist/agent/help-question.js +2 -1
  16. package/dist/agent/help.d.ts +1 -1
  17. package/dist/agent/help.js +1 -2
  18. package/dist/agent/instruction-detail.d.ts +2 -0
  19. package/dist/agent/instruction-detail.js +2 -0
  20. package/dist/agent/instruction-kind.d.ts +2 -0
  21. package/dist/agent/instruction-kind.js +2 -0
  22. package/dist/agent/instruction-manifest.d.ts +1 -0
  23. package/dist/agent/instruction-manifest.js +1 -0
  24. package/dist/agent/instruction-pointer.d.ts +1 -0
  25. package/dist/agent/instruction-pointer.js +1 -0
  26. package/dist/agent/instruction.d.ts +2 -0
  27. package/dist/agent/instruction.js +2 -0
  28. package/dist/{personal/api-key.d.ts → api/key.d.ts} +10 -10
  29. package/dist/{personal/api-key.js → api/key.js} +8 -8
  30. package/dist/auth/client.d.ts +1 -0
  31. package/dist/auth/client.js +2 -0
  32. package/dist/auth/provider-catalog.d.ts +1 -0
  33. package/dist/billing/additional-usage-funding-type.d.ts +16 -0
  34. package/dist/billing/additional-usage-funding-type.js +13 -0
  35. package/dist/billing/additional-usage-meter.d.ts +28 -0
  36. package/dist/billing/additional-usage-meter.js +20 -0
  37. package/dist/billing/additional-usage-type.d.ts +23 -0
  38. package/dist/billing/additional-usage-type.js +23 -0
  39. package/dist/billing/additional-usage.d.ts +38 -0
  40. package/dist/billing/additional-usage.js +35 -0
  41. package/dist/billing/catalog-additional-usage.d.ts +27 -0
  42. package/dist/billing/catalog-additional-usage.js +19 -0
  43. package/dist/billing/catalog-allowance.d.ts +26 -0
  44. package/dist/billing/catalog-allowance.js +25 -0
  45. package/dist/billing/catalog-credit-pack.d.ts +24 -0
  46. package/dist/billing/catalog-credit-pack.js +19 -0
  47. package/dist/billing/catalog-plan.d.ts +34 -0
  48. package/dist/billing/catalog-plan.js +25 -0
  49. package/dist/billing/catalog-tier.d.ts +32 -0
  50. package/dist/billing/catalog-tier.js +21 -0
  51. package/dist/billing/catalog.d.ts +63 -0
  52. package/dist/billing/catalog.js +24 -0
  53. package/dist/billing/checkout-mutation.d.ts +23 -0
  54. package/dist/billing/checkout-mutation.js +17 -0
  55. package/dist/billing/checkout.d.ts +25 -0
  56. package/dist/billing/checkout.js +18 -0
  57. package/dist/billing/credit-pack-type.d.ts +18 -0
  58. package/dist/billing/credit-pack-type.js +13 -0
  59. package/dist/billing/plan-type.d.ts +24 -0
  60. package/dist/billing/plan-type.js +24 -0
  61. package/dist/billing/portal.d.ts +17 -0
  62. package/dist/billing/portal.js +15 -0
  63. package/dist/billing/subscription.d.ts +150 -0
  64. package/dist/billing/subscription.js +36 -0
  65. package/dist/blog/post-type.d.ts +0 -1
  66. package/dist/blog/post-type.js +0 -1
  67. package/dist/blog/post.d.ts +0 -1
  68. package/dist/blog/post.js +1 -2
  69. package/dist/classification/classification.d.ts +1 -6
  70. package/dist/classification/classification.js +1 -6
  71. package/dist/cli/authorization-delivery.d.ts +1 -1
  72. package/dist/cli/authorization-delivery.js +2 -2
  73. package/dist/cli/authorization-poll.d.ts +1 -1
  74. package/dist/cli/authorization-terminal-reason.d.ts +1 -1
  75. package/dist/cli/authorization-terminal-reason.js +1 -1
  76. package/dist/cli/authorization.d.ts +1 -1
  77. package/dist/confidence/confidence.d.ts +3 -4
  78. package/dist/confidence/confidence.js +3 -4
  79. package/dist/content/compliance.d.ts +2 -5
  80. package/dist/content/compliance.js +2 -5
  81. package/dist/content/embedding-match.d.ts +2 -9
  82. package/dist/content/embedding-match.js +2 -9
  83. package/dist/content/source-type.d.ts +2 -9
  84. package/dist/content/source-type.js +2 -9
  85. package/dist/datasource/agent-identity.d.ts +1 -1
  86. package/dist/datasource/agent-identity.js +1 -1
  87. package/dist/datasource/data-source-type.d.ts +1 -1
  88. package/dist/datasource/data-source-type.js +1 -1
  89. package/dist/datasource/field-provenance.d.ts +1 -1
  90. package/dist/datasource/field-provenance.js +1 -1
  91. package/dist/datasource/provenance-actor-type.d.ts +1 -1
  92. package/dist/datasource/provenance-actor-type.js +1 -1
  93. package/dist/datasource/provenance-actor.d.ts +1 -1
  94. package/dist/datasource/provenance-actor.js +1 -1
  95. package/dist/datasource/provenance-field-change.d.ts +1 -1
  96. package/dist/datasource/provenance-field-change.js +1 -1
  97. package/dist/datasource/provenance-operation.d.ts +1 -1
  98. package/dist/datasource/provenance-operation.js +1 -1
  99. package/dist/datasource/provenance-source.d.ts +1 -1
  100. package/dist/datasource/provenance-source.js +1 -1
  101. package/dist/datasource/provenance-status.d.ts +1 -1
  102. package/dist/datasource/provenance-status.js +1 -1
  103. package/dist/datasource/source-metadata.d.ts +3 -26
  104. package/dist/datasource/source-metadata.js +3 -26
  105. package/dist/datasource/tracked-provenance-table.d.ts +1 -1
  106. package/dist/datasource/tracked-provenance-table.js +1 -1
  107. package/dist/decimal/range.d.ts +2 -4
  108. package/dist/decimal/range.js +2 -4
  109. package/dist/employee/count.d.ts +1 -1
  110. package/dist/employee/count.js +1 -1
  111. package/dist/entity/accelerator-participation.d.ts +1 -6
  112. package/dist/entity/accelerator-participation.js +1 -5
  113. package/dist/entity/acquisition.d.ts +0 -2
  114. package/dist/entity/alias-type.d.ts +5 -11
  115. package/dist/entity/alias-type.js +5 -11
  116. package/dist/entity/classification.d.ts +1 -5
  117. package/dist/entity/classification.js +1 -5
  118. package/dist/entity/comparison-signals.d.ts +0 -3
  119. package/dist/entity/comparison-signals.js +0 -3
  120. package/dist/entity/detail-batch.d.ts +0 -1
  121. package/dist/entity/detail-batch.js +0 -1
  122. package/dist/entity/detail.d.ts +4 -54
  123. package/dist/entity/detail.js +0 -3
  124. package/dist/entity/enrichment.d.ts +2 -5
  125. package/dist/entity/enrichment.js +1 -5
  126. package/dist/entity/entity.d.ts +6 -13
  127. package/dist/entity/entity.js +6 -14
  128. package/dist/entity/filter-count-meta.d.ts +0 -1
  129. package/dist/entity/filter-count-meta.js +0 -1
  130. package/dist/entity/filter-count-result.d.ts +0 -1
  131. package/dist/entity/filter-count-result.js +0 -1
  132. package/dist/entity/filter-logo-option.d.ts +3 -3
  133. package/dist/entity/filter-logo-option.js +2 -2
  134. package/dist/entity/filter-search-result.d.ts +0 -1
  135. package/dist/entity/filter-search-result.js +0 -1
  136. package/dist/entity/filter-search.d.ts +10 -3
  137. package/dist/entity/filter.d.ts +11 -4
  138. package/dist/entity/filter.js +4 -3
  139. package/dist/entity/filters-counts-param.d.ts +19 -0
  140. package/dist/entity/filters-counts-param.js +23 -0
  141. package/dist/entity/funding-detail.d.ts +2 -5
  142. package/dist/entity/funding-detail.js +3 -5
  143. package/dist/entity/fundraise-filter-criteria.d.ts +1 -1
  144. package/dist/entity/fundraise-filter-criteria.js +1 -1
  145. package/dist/entity/fundraise-investor-activity.d.ts +1 -1
  146. package/dist/entity/fundraise-investor-activity.js +1 -1
  147. package/dist/entity/fundraise-investor-join.d.ts +2 -2
  148. package/dist/entity/fundraise-investor-join.js +3 -3
  149. package/dist/entity/fundraise-transaction-entity.d.ts +2 -6
  150. package/dist/entity/fundraise-transaction-entity.js +1 -5
  151. package/dist/entity/fundraise-transaction.d.ts +2 -6
  152. package/dist/entity/fundraise-transaction.js +1 -5
  153. package/dist/entity/fundraise.d.ts +1 -7
  154. package/dist/entity/fundraise.js +1 -7
  155. package/dist/entity/image.d.ts +5 -11
  156. package/dist/entity/image.js +5 -11
  157. package/dist/entity/investments-param.js +1 -1
  158. package/dist/entity/investor-participation.d.ts +4 -51
  159. package/dist/entity/investors-param.js +1 -1
  160. package/dist/entity/list-filter.d.ts +12 -4
  161. package/dist/entity/list-filter.js +6 -4
  162. package/dist/entity/list-quality-gate.d.ts +1 -2
  163. package/dist/entity/list-quality-gate.js +1 -2
  164. package/dist/entity/list-research.d.ts +1 -11
  165. package/dist/entity/list-research.js +1 -3
  166. package/dist/entity/list-summary.d.ts +3 -3
  167. package/dist/entity/list.d.ts +5 -14
  168. package/dist/entity/list.js +1 -3
  169. package/dist/entity/logo-type.d.ts +1 -1
  170. package/dist/entity/logo-type.js +1 -1
  171. package/dist/entity/lookup-batch-param.d.ts +18 -0
  172. package/dist/entity/{detail-batch-param.js → lookup-batch-param.js} +7 -7
  173. package/dist/entity/lookup-param.js +3 -3
  174. package/dist/entity/name-alias-entity-alias-type.d.ts +5 -11
  175. package/dist/entity/name-alias-entity-alias-type.js +5 -11
  176. package/dist/entity/name-alias-person-alias-type.d.ts +1 -7
  177. package/dist/entity/name-alias-person-alias-type.js +1 -7
  178. package/dist/entity/natural-search.d.ts +11 -3
  179. package/dist/entity/natural-search.js +1 -0
  180. package/dist/entity/operating-status.d.ts +28 -0
  181. package/dist/entity/operating-status.js +28 -0
  182. package/dist/entity/people-param.d.ts +27 -0
  183. package/dist/entity/people-param.js +34 -0
  184. package/dist/entity/person-association.d.ts +0 -9
  185. package/dist/entity/person-association.js +0 -10
  186. package/dist/entity/person-owner.d.ts +1 -2
  187. package/dist/entity/person-owner.js +1 -2
  188. package/dist/entity/relationship.d.ts +0 -4
  189. package/dist/entity/relationship.js +0 -3
  190. package/dist/entity/research-detail.d.ts +3 -14
  191. package/dist/entity/research-detail.js +3 -11
  192. package/dist/entity/research-fact-value.d.ts +1 -1
  193. package/dist/entity/research-fact-value.js +1 -1
  194. package/dist/entity/research-snippet.d.ts +2 -9
  195. package/dist/entity/research-snippet.js +2 -12
  196. package/dist/entity/research-value-type.d.ts +4 -8
  197. package/dist/entity/research-value-type.js +4 -8
  198. package/dist/entity/research.d.ts +0 -15
  199. package/dist/entity/research.js +0 -3
  200. package/dist/entity/resolution.d.ts +4 -51
  201. package/dist/entity/search-param.js +2 -2
  202. package/dist/entity/similarity-context.d.ts +0 -1
  203. package/dist/entity/similarity-context.js +0 -1
  204. package/dist/entity/similarity-origin.d.ts +0 -1
  205. package/dist/entity/similarity-origin.js +0 -1
  206. package/dist/entity/similarity-result.d.ts +4 -13
  207. package/dist/entity/similarity-result.js +0 -1
  208. package/dist/entity/sitemap.d.ts +5 -11
  209. package/dist/entity/sitemap.js +5 -11
  210. package/dist/entity/suggestion-result.d.ts +4 -12
  211. package/dist/entity/suggestion.d.ts +4 -12
  212. package/dist/entity/tag-count.d.ts +0 -1
  213. package/dist/entity/tag-count.js +0 -1
  214. package/dist/entity/tag.d.ts +1 -7
  215. package/dist/entity/tag.js +1 -7
  216. package/dist/entity/text-bundle.d.ts +2 -9
  217. package/dist/entity/text-bundle.js +2 -9
  218. package/dist/entity/url-crawl-cdn-provider.d.ts +1 -10
  219. package/dist/entity/url-crawl-cdn-provider.js +1 -10
  220. package/dist/entity/url-crawl-render-mode.d.ts +1 -10
  221. package/dist/entity/url-crawl-render-mode.js +1 -10
  222. package/dist/entity/url-link.d.ts +1 -10
  223. package/dist/entity/url-link.js +1 -10
  224. package/dist/entity/url-type.d.ts +1 -10
  225. package/dist/entity/url-type.js +1 -10
  226. package/dist/entity/valuation-data-confidence.d.ts +1 -22
  227. package/dist/entity/valuation-data-confidence.js +1 -22
  228. package/dist/federated/search.d.ts +10 -36
  229. package/dist/funding/stage.d.ts +1 -5
  230. package/dist/funding/stage.js +1 -5
  231. package/dist/fundraise/data-confidence.d.ts +1 -5
  232. package/dist/fundraise/data-confidence.js +1 -5
  233. package/dist/fundraise/financial-instrument-type.d.ts +2 -2
  234. package/dist/fundraise/financial-instrument-type.js +2 -2
  235. package/dist/fundraise/investment-attribution-type.d.ts +2 -9
  236. package/dist/fundraise/investment-attribution-type.js +2 -9
  237. package/dist/fundraise/investment-attribution.d.ts +2 -9
  238. package/dist/fundraise/investment-attribution.js +2 -9
  239. package/dist/help/citation.d.ts +1 -0
  240. package/dist/help/citation.js +1 -0
  241. package/dist/help/scope.d.ts +1 -0
  242. package/dist/help/scope.js +1 -0
  243. package/dist/help/source-type.d.ts +1 -0
  244. package/dist/help/source-type.js +1 -0
  245. package/dist/http/problem-detail.d.ts +26 -1
  246. package/dist/http/problem-detail.js +84 -1
  247. package/dist/identification/candidate.d.ts +37 -0
  248. package/dist/identification/candidate.js +20 -0
  249. package/dist/identification/identification.d.ts +77 -0
  250. package/dist/identification/identification.js +28 -0
  251. package/dist/identification/subject.d.ts +23 -0
  252. package/dist/identification/subject.js +27 -0
  253. package/dist/int/range.d.ts +2 -4
  254. package/dist/int/range.js +2 -4
  255. package/dist/investor/activity-filter.d.ts +2 -2
  256. package/dist/investor/activity-filter.js +2 -2
  257. package/dist/link/search.d.ts +10 -36
  258. package/dist/location/directory-entry.d.ts +1 -2
  259. package/dist/location/directory-entry.js +1 -2
  260. package/dist/location/identifier.d.ts +1 -1
  261. package/dist/location/identifier.js +1 -1
  262. package/dist/location/scope.d.ts +1 -1
  263. package/dist/location/scope.js +1 -1
  264. package/dist/location/sitemap.d.ts +81 -18
  265. package/dist/location/sitemap.js +5 -4
  266. package/dist/media/object-type.d.ts +3 -3
  267. package/dist/media/object-type.js +3 -3
  268. package/dist/media/slot.d.ts +18 -0
  269. package/dist/media/slot.js +14 -0
  270. package/dist/media/upload.d.ts +3 -3
  271. package/dist/media/upload.js +3 -3
  272. package/dist/natural/search-result.d.ts +9 -16
  273. package/dist/natural/search-result.js +1 -0
  274. package/dist/natural/search.d.ts +2 -0
  275. package/dist/natural/search.js +3 -1
  276. package/dist/news/detail.d.ts +14 -24
  277. package/dist/news/detail.js +10 -12
  278. package/dist/news/match-status.d.ts +20 -0
  279. package/dist/news/match-status.js +15 -0
  280. package/dist/news/news.d.ts +0 -10
  281. package/dist/news/news.js +0 -10
  282. package/dist/news/resolved-entity-link.d.ts +7 -4
  283. package/dist/news/resolved-entity-link.js +3 -4
  284. package/dist/news/resolved-person-link.d.ts +6 -3
  285. package/dist/news/resolved-person-link.js +2 -3
  286. package/dist/news/source-url-conflict.js +1 -1
  287. package/dist/openapi-component-manifest.js +78 -38
  288. package/dist/pageable/object.d.ts +15 -29
  289. package/dist/pageable/object.js +15 -29
  290. package/dist/pagination/schemas.d.ts +49 -520
  291. package/dist/pagination/schemas.js +23 -100
  292. package/dist/person/alias-type.d.ts +1 -7
  293. package/dist/person/alias-type.js +1 -7
  294. package/dist/person/detail.d.ts +0 -30
  295. package/dist/person/detail.js +0 -7
  296. package/dist/person/enrichment.d.ts +0 -6
  297. package/dist/person/enrichment.js +0 -6
  298. package/dist/person/filter.d.ts +2 -1
  299. package/dist/person/filter.js +3 -1
  300. package/dist/person/graph-career-context.d.ts +3 -5
  301. package/dist/person/graph-co-investor.d.ts +0 -1
  302. package/dist/person/graph-similar-entity.d.ts +1 -1
  303. package/dist/person/graph.d.ts +4 -8
  304. package/dist/person/image.d.ts +1 -7
  305. package/dist/person/image.js +1 -7
  306. package/dist/person/invested-company.d.ts +1 -8
  307. package/dist/person/invested-company.js +1 -7
  308. package/dist/person/investment.d.ts +1 -9
  309. package/dist/person/investment.js +1 -7
  310. package/dist/person/investor-participation.d.ts +0 -28
  311. package/dist/person/list-array-filter.d.ts +1 -1
  312. package/dist/person/list-array-filter.js +1 -1
  313. package/dist/person/lookup-batch-param.d.ts +18 -0
  314. package/dist/person/lookup-batch-param.js +21 -0
  315. package/dist/person/{detail-batch.d.ts → lookup-batch.d.ts} +7 -8
  316. package/dist/person/{detail-batch.js → lookup-batch.js} +5 -6
  317. package/dist/person/lookup-param.js +1 -1
  318. package/dist/person/natural-search-result.d.ts +3 -18
  319. package/dist/person/natural-search-result.js +1 -0
  320. package/dist/person/natural-search.d.ts +2 -0
  321. package/dist/person/natural-search.js +1 -0
  322. package/dist/person/person.d.ts +1 -16
  323. package/dist/person/person.js +1 -9
  324. package/dist/person/search-interpretation.d.ts +2 -0
  325. package/dist/person/search-interpretation.js +1 -0
  326. package/dist/person/search-param.js +2 -2
  327. package/dist/person/similarity-result.d.ts +0 -21
  328. package/dist/problem/type.d.ts +1 -0
  329. package/dist/problem/type.js +1 -0
  330. package/dist/publication/facet.d.ts +29 -0
  331. package/dist/publication/facet.js +22 -0
  332. package/dist/publication/publication.d.ts +0 -1
  333. package/dist/publication/publication.js +1 -2
  334. package/dist/publication/relation.d.ts +0 -1
  335. package/dist/publication/relation.js +0 -1
  336. package/dist/publication/type.d.ts +3 -1
  337. package/dist/publication/type.js +3 -1
  338. package/dist/relationship/direction.d.ts +1 -1
  339. package/dist/relationship/direction.js +1 -1
  340. package/dist/research/allowance-usage.d.ts +81 -0
  341. package/dist/research/allowance-usage.js +20 -0
  342. package/dist/research/allowance.d.ts +20 -0
  343. package/dist/research/allowance.js +20 -0
  344. package/dist/research/derived-bucket.d.ts +3 -7
  345. package/dist/research/derived-bucket.js +3 -7
  346. package/dist/research/derived-range.d.ts +3 -7
  347. package/dist/research/derived-range.js +3 -7
  348. package/dist/resolved/handle.d.ts +2 -1
  349. package/dist/resolved/handle.js +2 -1
  350. package/dist/round/label.d.ts +2 -9
  351. package/dist/round/label.js +2 -9
  352. package/dist/search/duplicate-candidate-score.d.ts +1 -0
  353. package/dist/search/duplicate-candidate-score.js +2 -1
  354. package/dist/search/hit.d.ts +1 -1
  355. package/dist/search/hit.js +1 -1
  356. package/dist/search/interpretation.d.ts +5 -4
  357. package/dist/search/interpretation.js +1 -0
  358. package/dist/search/mode-execution.d.ts +2 -0
  359. package/dist/search/mode-execution.js +2 -0
  360. package/dist/search/mode.d.ts +2 -1
  361. package/dist/search/mode.js +2 -1
  362. package/dist/search/ordering-entity-filter-sortable.d.ts +1 -0
  363. package/dist/search/ordering-entity-filter-sortable.js +1 -0
  364. package/dist/search/ordering-person-sort-field.d.ts +1 -0
  365. package/dist/search/ordering-person-sort-field.js +1 -0
  366. package/dist/search/relevance.d.ts +2 -0
  367. package/dist/search/relevance.js +2 -0
  368. package/dist/search/search.d.ts +1 -1
  369. package/dist/search/search.js +1 -1
  370. package/dist/sitemap/url-slot.d.ts +0 -1
  371. package/dist/sitemap/url-slot.js +0 -1
  372. package/dist/sort/object.d.ts +15 -29
  373. package/dist/sort/object.js +15 -29
  374. package/dist/sort/order-entity-filter-sortable.d.ts +1 -0
  375. package/dist/sort/order-entity-filter-sortable.js +1 -0
  376. package/dist/sort/order-person-sort-field.d.ts +1 -0
  377. package/dist/sort/order-person-sort-field.js +1 -0
  378. package/dist/source/document-list.d.ts +1 -1
  379. package/dist/source/document-list.js +1 -1
  380. package/dist/stage/frequency.d.ts +1 -1
  381. package/dist/stage/frequency.js +1 -1
  382. package/dist/standardized/classification.d.ts +1 -5
  383. package/dist/standardized/classification.js +1 -5
  384. package/dist/unique/id-owner-scope.d.ts +1 -0
  385. package/dist/unique/id-owner-scope.js +1 -0
  386. package/dist/unique/id-type-alias.d.ts +1 -0
  387. package/dist/unique/id-type-alias.js +1 -0
  388. package/dist/unique/id-type.d.ts +1 -3
  389. package/dist/unique/id-type.js +1 -3
  390. package/dist/unique/id.d.ts +1 -3
  391. package/dist/unique/id.js +1 -3
  392. package/dist/url/match-mode.d.ts +1 -2
  393. package/dist/url/match-mode.js +1 -2
  394. package/dist/url/slug-redirect.d.ts +1 -3
  395. package/dist/url/slug-redirect.js +1 -3
  396. package/dist/url/type-alias.d.ts +2 -2
  397. package/dist/url/type-alias.js +2 -2
  398. package/dist/web/search.d.ts +1 -1
  399. package/dist/web/search.js +1 -1
  400. package/package.json +1 -1
  401. package/dist/entity/batch-param.d.ts +0 -22
  402. package/dist/entity/batch-param.js +0 -24
  403. package/dist/entity/detail-batch-param.d.ts +0 -18
  404. package/dist/entity/detail-similar-param.d.ts +0 -22
  405. package/dist/entity/detail-similar-param.js +0 -33
  406. package/dist/entity/filter-count.d.ts +0 -20
  407. package/dist/entity/filter-count.js +0 -22
  408. package/dist/news/filter.d.ts +0 -27
  409. package/dist/news/filter.js +0 -31
  410. package/dist/person/batch-param.d.ts +0 -27
  411. package/dist/person/batch-param.js +0 -38
  412. package/dist/publication/filter.d.ts +0 -35
  413. package/dist/publication/filter.js +0 -27
  414. package/dist/publication/search-interpretation.d.ts +0 -48
  415. package/dist/publication/search-interpretation.js +0 -30
  416. package/dist/publication/search-result.d.ts +0 -94
  417. package/dist/publication/search-result.js +0 -22
  418. package/dist/publication/sort-field.d.ts +0 -25
  419. package/dist/publication/sort-field.js +0 -25
  420. package/dist/sort/order-publication-sort-field.d.ts +0 -31
  421. package/dist/sort/order-publication-sort-field.js +0 -22
  422. package/dist/sort/spec-publication-sort-field.d.ts +0 -26
  423. package/dist/sort/spec-publication-sort-field.js +0 -20
package/README.md CHANGED
@@ -2,4 +2,10 @@
2
2
 
3
3
  Zod v4 schemas for the public aVenture API.
4
4
 
5
- This package is generated from the canonical back-end OpenAPI spec and must not be hand-edited.
5
+ Generated from the published aVenture OpenAPI specification; do not edit by hand.
6
+
7
+ ```bash
8
+ npm install @aventurevc/api-schemas --@aventurevc:registry=https://registry.npmjs.org/
9
+ ```
10
+
11
+ Endpoint reference: https://docs.aventure.vc/api-reference
@@ -3,11 +3,7 @@ import { z } from "zod/v4";
3
3
  * Canonical address record for entity and person payloads
4
4
  *
5
5
  * @openapiSchema Address
6
- * @endpoint GET /v1/entities
7
- * @endpoint GET /v1/entities/detail
8
- * @endpoint GET /v1/entities/detail/similar
9
6
  * @endpoint GET /v1/entities/lookup
10
- * @endpoint GET /v1/people/detail
11
7
  * @endpoint GET /v1/people/lookup
12
8
  * @endpoint GET /v1/search/link
13
9
  * @endpoint GET /v1/entities/{entityId}
@@ -27,16 +23,13 @@ import { z } from "zod/v4";
27
23
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
28
24
  * @endpoint GET /v1/people/{personId}/graph
29
25
  * @endpoint GET /v1/people/{personId}/similar
30
- * @endpoint POST /v1/entities/batch
31
- * @endpoint POST /v1/entities/detail/batch
32
26
  * @endpoint POST /v1/entities/lookup/batch
33
27
  * @endpoint POST /v1/entities/lookup/matches
34
28
  * @endpoint POST /v1/entities/natural-search
35
29
  * @endpoint POST /v1/entities/search
36
- * @endpoint POST /v1/people/batch
37
- * @endpoint POST /v1/people/detail/batch
38
30
  * @endpoint POST /v1/people/lookup/batch
39
31
  * @endpoint POST /v1/search/all
32
+ * @endpoint POST /v1/search/natural/entities
40
33
  * @usedBySchema EntityEnrichmentSchema
41
34
  * @usedBySchema EntityPersonAssociationSchema
42
35
  * @usedBySchema PersonEnrichmentSchema
@@ -8,11 +8,7 @@ import { AddressStateSchema } from "./state.js";
8
8
  * Canonical address record for entity and person payloads
9
9
  *
10
10
  * @openapiSchema Address
11
- * @endpoint GET /v1/entities
12
- * @endpoint GET /v1/entities/detail
13
- * @endpoint GET /v1/entities/detail/similar
14
11
  * @endpoint GET /v1/entities/lookup
15
- * @endpoint GET /v1/people/detail
16
12
  * @endpoint GET /v1/people/lookup
17
13
  * @endpoint GET /v1/search/link
18
14
  * @endpoint GET /v1/entities/{entityId}
@@ -32,16 +28,13 @@ import { AddressStateSchema } from "./state.js";
32
28
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
33
29
  * @endpoint GET /v1/people/{personId}/graph
34
30
  * @endpoint GET /v1/people/{personId}/similar
35
- * @endpoint POST /v1/entities/batch
36
- * @endpoint POST /v1/entities/detail/batch
37
31
  * @endpoint POST /v1/entities/lookup/batch
38
32
  * @endpoint POST /v1/entities/lookup/matches
39
33
  * @endpoint POST /v1/entities/natural-search
40
34
  * @endpoint POST /v1/entities/search
41
- * @endpoint POST /v1/people/batch
42
- * @endpoint POST /v1/people/detail/batch
43
35
  * @endpoint POST /v1/people/lookup/batch
44
36
  * @endpoint POST /v1/search/all
37
+ * @endpoint POST /v1/search/natural/entities
45
38
  * @usedBySchema EntityEnrichmentSchema
46
39
  * @usedBySchema EntityPersonAssociationSchema
47
40
  * @usedBySchema PersonEnrichmentSchema
@@ -3,11 +3,7 @@ import { z } from "zod/v4";
3
3
  * Meaning of an entity or person address association. Domicile is a legal or registered seat and is not evidence of operational presence; dominant is the predominant display location; origin is the founding or historical location.
4
4
  *
5
5
  * @openapiSchema AddressAssociationRole
6
- * @endpoint GET /v1/entities
7
- * @endpoint GET /v1/entities/detail
8
- * @endpoint GET /v1/entities/detail/similar
9
6
  * @endpoint GET /v1/entities/lookup
10
- * @endpoint GET /v1/people/detail
11
7
  * @endpoint GET /v1/people/lookup
12
8
  * @endpoint GET /v1/search/link
13
9
  * @endpoint GET /v1/entities/{entityId}
@@ -27,16 +23,13 @@ import { z } from "zod/v4";
27
23
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
28
24
  * @endpoint GET /v1/people/{personId}/graph
29
25
  * @endpoint GET /v1/people/{personId}/similar
30
- * @endpoint POST /v1/entities/batch
31
- * @endpoint POST /v1/entities/detail/batch
32
26
  * @endpoint POST /v1/entities/lookup/batch
33
27
  * @endpoint POST /v1/entities/lookup/matches
34
28
  * @endpoint POST /v1/entities/natural-search
35
29
  * @endpoint POST /v1/entities/search
36
- * @endpoint POST /v1/people/batch
37
- * @endpoint POST /v1/people/detail/batch
38
30
  * @endpoint POST /v1/people/lookup/batch
39
31
  * @endpoint POST /v1/search/all
32
+ * @endpoint POST /v1/search/natural/entities
40
33
  * @usedBySchema AddressAssociationSchema
41
34
  * @contractShape address.association-role
42
35
  * @contractRole canonical
@@ -4,11 +4,7 @@ import { z } from "zod/v4";
4
4
  * Meaning of an entity or person address association. Domicile is a legal or registered seat and is not evidence of operational presence; dominant is the predominant display location; origin is the founding or historical location.
5
5
  *
6
6
  * @openapiSchema AddressAssociationRole
7
- * @endpoint GET /v1/entities
8
- * @endpoint GET /v1/entities/detail
9
- * @endpoint GET /v1/entities/detail/similar
10
7
  * @endpoint GET /v1/entities/lookup
11
- * @endpoint GET /v1/people/detail
12
8
  * @endpoint GET /v1/people/lookup
13
9
  * @endpoint GET /v1/search/link
14
10
  * @endpoint GET /v1/entities/{entityId}
@@ -28,16 +24,13 @@ import { z } from "zod/v4";
28
24
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
29
25
  * @endpoint GET /v1/people/{personId}/graph
30
26
  * @endpoint GET /v1/people/{personId}/similar
31
- * @endpoint POST /v1/entities/batch
32
- * @endpoint POST /v1/entities/detail/batch
33
27
  * @endpoint POST /v1/entities/lookup/batch
34
28
  * @endpoint POST /v1/entities/lookup/matches
35
29
  * @endpoint POST /v1/entities/natural-search
36
30
  * @endpoint POST /v1/entities/search
37
- * @endpoint POST /v1/people/batch
38
- * @endpoint POST /v1/people/detail/batch
39
31
  * @endpoint POST /v1/people/lookup/batch
40
32
  * @endpoint POST /v1/search/all
33
+ * @endpoint POST /v1/search/natural/entities
41
34
  * @usedBySchema AddressAssociationSchema
42
35
  * @contractShape address.association-role
43
36
  * @contractRole canonical
@@ -15,11 +15,7 @@ type AddressAssociationDefinition = z.infer<typeof AddressAssociationSchemaDefin
15
15
  * One role and effective period for a physical address association
16
16
  *
17
17
  * @openapiSchema AddressAssociation
18
- * @endpoint GET /v1/entities
19
- * @endpoint GET /v1/entities/detail
20
- * @endpoint GET /v1/entities/detail/similar
21
18
  * @endpoint GET /v1/entities/lookup
22
- * @endpoint GET /v1/people/detail
23
19
  * @endpoint GET /v1/people/lookup
24
20
  * @endpoint GET /v1/search/link
25
21
  * @endpoint GET /v1/entities/{entityId}
@@ -39,16 +35,13 @@ type AddressAssociationDefinition = z.infer<typeof AddressAssociationSchemaDefin
39
35
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
40
36
  * @endpoint GET /v1/people/{personId}/graph
41
37
  * @endpoint GET /v1/people/{personId}/similar
42
- * @endpoint POST /v1/entities/batch
43
- * @endpoint POST /v1/entities/detail/batch
44
38
  * @endpoint POST /v1/entities/lookup/batch
45
39
  * @endpoint POST /v1/entities/lookup/matches
46
40
  * @endpoint POST /v1/entities/natural-search
47
41
  * @endpoint POST /v1/entities/search
48
- * @endpoint POST /v1/people/batch
49
- * @endpoint POST /v1/people/detail/batch
50
42
  * @endpoint POST /v1/people/lookup/batch
51
43
  * @endpoint POST /v1/search/all
44
+ * @endpoint POST /v1/search/natural/entities
52
45
  * @usedBySchema AddressSchema
53
46
  * @contractShape address.association
54
47
  * @contractRole canonical
@@ -17,11 +17,7 @@ const AddressAssociationSchemaDefinition = z.object({
17
17
  * One role and effective period for a physical address association
18
18
  *
19
19
  * @openapiSchema AddressAssociation
20
- * @endpoint GET /v1/entities
21
- * @endpoint GET /v1/entities/detail
22
- * @endpoint GET /v1/entities/detail/similar
23
20
  * @endpoint GET /v1/entities/lookup
24
- * @endpoint GET /v1/people/detail
25
21
  * @endpoint GET /v1/people/lookup
26
22
  * @endpoint GET /v1/search/link
27
23
  * @endpoint GET /v1/entities/{entityId}
@@ -41,16 +37,13 @@ const AddressAssociationSchemaDefinition = z.object({
41
37
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
42
38
  * @endpoint GET /v1/people/{personId}/graph
43
39
  * @endpoint GET /v1/people/{personId}/similar
44
- * @endpoint POST /v1/entities/batch
45
- * @endpoint POST /v1/entities/detail/batch
46
40
  * @endpoint POST /v1/entities/lookup/batch
47
41
  * @endpoint POST /v1/entities/lookup/matches
48
42
  * @endpoint POST /v1/entities/natural-search
49
43
  * @endpoint POST /v1/entities/search
50
- * @endpoint POST /v1/people/batch
51
- * @endpoint POST /v1/people/detail/batch
52
44
  * @endpoint POST /v1/people/lookup/batch
53
45
  * @endpoint POST /v1/search/all
46
+ * @endpoint POST /v1/search/natural/entities
54
47
  * @usedBySchema AddressSchema
55
48
  * @contractShape address.association
56
49
  * @contractRole canonical
@@ -3,11 +3,7 @@ import { z } from "zod/v4";
3
3
  * City reference used inside an address
4
4
  *
5
5
  * @openapiSchema AddressCity
6
- * @endpoint GET /v1/entities
7
- * @endpoint GET /v1/entities/detail
8
- * @endpoint GET /v1/entities/detail/similar
9
6
  * @endpoint GET /v1/entities/lookup
10
- * @endpoint GET /v1/people/detail
11
7
  * @endpoint GET /v1/people/lookup
12
8
  * @endpoint GET /v1/search/link
13
9
  * @endpoint GET /v1/entities/{entityId}
@@ -27,16 +23,13 @@ import { z } from "zod/v4";
27
23
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
28
24
  * @endpoint GET /v1/people/{personId}/graph
29
25
  * @endpoint GET /v1/people/{personId}/similar
30
- * @endpoint POST /v1/entities/batch
31
- * @endpoint POST /v1/entities/detail/batch
32
26
  * @endpoint POST /v1/entities/lookup/batch
33
27
  * @endpoint POST /v1/entities/lookup/matches
34
28
  * @endpoint POST /v1/entities/natural-search
35
29
  * @endpoint POST /v1/entities/search
36
- * @endpoint POST /v1/people/batch
37
- * @endpoint POST /v1/people/detail/batch
38
30
  * @endpoint POST /v1/people/lookup/batch
39
31
  * @endpoint POST /v1/search/all
32
+ * @endpoint POST /v1/search/natural/entities
40
33
  * @usedBySchema AddressSchema
41
34
  * @contractShape address.city
42
35
  * @contractRole canonical
@@ -4,11 +4,7 @@ import { z } from "zod/v4";
4
4
  * City reference used inside an address
5
5
  *
6
6
  * @openapiSchema AddressCity
7
- * @endpoint GET /v1/entities
8
- * @endpoint GET /v1/entities/detail
9
- * @endpoint GET /v1/entities/detail/similar
10
7
  * @endpoint GET /v1/entities/lookup
11
- * @endpoint GET /v1/people/detail
12
8
  * @endpoint GET /v1/people/lookup
13
9
  * @endpoint GET /v1/search/link
14
10
  * @endpoint GET /v1/entities/{entityId}
@@ -28,16 +24,13 @@ import { z } from "zod/v4";
28
24
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
29
25
  * @endpoint GET /v1/people/{personId}/graph
30
26
  * @endpoint GET /v1/people/{personId}/similar
31
- * @endpoint POST /v1/entities/batch
32
- * @endpoint POST /v1/entities/detail/batch
33
27
  * @endpoint POST /v1/entities/lookup/batch
34
28
  * @endpoint POST /v1/entities/lookup/matches
35
29
  * @endpoint POST /v1/entities/natural-search
36
30
  * @endpoint POST /v1/entities/search
37
- * @endpoint POST /v1/people/batch
38
- * @endpoint POST /v1/people/detail/batch
39
31
  * @endpoint POST /v1/people/lookup/batch
40
32
  * @endpoint POST /v1/search/all
33
+ * @endpoint POST /v1/search/natural/entities
41
34
  * @usedBySchema AddressSchema
42
35
  * @contractShape address.city
43
36
  * @contractRole canonical
@@ -3,11 +3,7 @@ import { z } from "zod/v4";
3
3
  * Country reference used inside an address
4
4
  *
5
5
  * @openapiSchema AddressCountry
6
- * @endpoint GET /v1/entities
7
- * @endpoint GET /v1/entities/detail
8
- * @endpoint GET /v1/entities/detail/similar
9
6
  * @endpoint GET /v1/entities/lookup
10
- * @endpoint GET /v1/people/detail
11
7
  * @endpoint GET /v1/people/lookup
12
8
  * @endpoint GET /v1/search/link
13
9
  * @endpoint GET /v1/entities/{entityId}
@@ -27,16 +23,13 @@ import { z } from "zod/v4";
27
23
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
28
24
  * @endpoint GET /v1/people/{personId}/graph
29
25
  * @endpoint GET /v1/people/{personId}/similar
30
- * @endpoint POST /v1/entities/batch
31
- * @endpoint POST /v1/entities/detail/batch
32
26
  * @endpoint POST /v1/entities/lookup/batch
33
27
  * @endpoint POST /v1/entities/lookup/matches
34
28
  * @endpoint POST /v1/entities/natural-search
35
29
  * @endpoint POST /v1/entities/search
36
- * @endpoint POST /v1/people/batch
37
- * @endpoint POST /v1/people/detail/batch
38
30
  * @endpoint POST /v1/people/lookup/batch
39
31
  * @endpoint POST /v1/search/all
32
+ * @endpoint POST /v1/search/natural/entities
40
33
  * @usedBySchema AddressSchema
41
34
  * @contractShape address.country
42
35
  * @contractRole canonical
@@ -4,11 +4,7 @@ import { z } from "zod/v4";
4
4
  * Country reference used inside an address
5
5
  *
6
6
  * @openapiSchema AddressCountry
7
- * @endpoint GET /v1/entities
8
- * @endpoint GET /v1/entities/detail
9
- * @endpoint GET /v1/entities/detail/similar
10
7
  * @endpoint GET /v1/entities/lookup
11
- * @endpoint GET /v1/people/detail
12
8
  * @endpoint GET /v1/people/lookup
13
9
  * @endpoint GET /v1/search/link
14
10
  * @endpoint GET /v1/entities/{entityId}
@@ -28,16 +24,13 @@ import { z } from "zod/v4";
28
24
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
29
25
  * @endpoint GET /v1/people/{personId}/graph
30
26
  * @endpoint GET /v1/people/{personId}/similar
31
- * @endpoint POST /v1/entities/batch
32
- * @endpoint POST /v1/entities/detail/batch
33
27
  * @endpoint POST /v1/entities/lookup/batch
34
28
  * @endpoint POST /v1/entities/lookup/matches
35
29
  * @endpoint POST /v1/entities/natural-search
36
30
  * @endpoint POST /v1/entities/search
37
- * @endpoint POST /v1/people/batch
38
- * @endpoint POST /v1/people/detail/batch
39
31
  * @endpoint POST /v1/people/lookup/batch
40
32
  * @endpoint POST /v1/search/all
33
+ * @endpoint POST /v1/search/natural/entities
41
34
  * @usedBySchema AddressSchema
42
35
  * @contractShape address.country
43
36
  * @contractRole canonical
@@ -3,11 +3,7 @@ import { z } from "zod/v4";
3
3
  * State or region reference used inside an address
4
4
  *
5
5
  * @openapiSchema AddressState
6
- * @endpoint GET /v1/entities
7
- * @endpoint GET /v1/entities/detail
8
- * @endpoint GET /v1/entities/detail/similar
9
6
  * @endpoint GET /v1/entities/lookup
10
- * @endpoint GET /v1/people/detail
11
7
  * @endpoint GET /v1/people/lookup
12
8
  * @endpoint GET /v1/search/link
13
9
  * @endpoint GET /v1/entities/{entityId}
@@ -27,16 +23,13 @@ import { z } from "zod/v4";
27
23
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
28
24
  * @endpoint GET /v1/people/{personId}/graph
29
25
  * @endpoint GET /v1/people/{personId}/similar
30
- * @endpoint POST /v1/entities/batch
31
- * @endpoint POST /v1/entities/detail/batch
32
26
  * @endpoint POST /v1/entities/lookup/batch
33
27
  * @endpoint POST /v1/entities/lookup/matches
34
28
  * @endpoint POST /v1/entities/natural-search
35
29
  * @endpoint POST /v1/entities/search
36
- * @endpoint POST /v1/people/batch
37
- * @endpoint POST /v1/people/detail/batch
38
30
  * @endpoint POST /v1/people/lookup/batch
39
31
  * @endpoint POST /v1/search/all
32
+ * @endpoint POST /v1/search/natural/entities
40
33
  * @usedBySchema AddressSchema
41
34
  * @contractShape address.state
42
35
  * @contractRole canonical
@@ -4,11 +4,7 @@ import { z } from "zod/v4";
4
4
  * State or region reference used inside an address
5
5
  *
6
6
  * @openapiSchema AddressState
7
- * @endpoint GET /v1/entities
8
- * @endpoint GET /v1/entities/detail
9
- * @endpoint GET /v1/entities/detail/similar
10
7
  * @endpoint GET /v1/entities/lookup
11
- * @endpoint GET /v1/people/detail
12
8
  * @endpoint GET /v1/people/lookup
13
9
  * @endpoint GET /v1/search/link
14
10
  * @endpoint GET /v1/entities/{entityId}
@@ -28,16 +24,13 @@ import { z } from "zod/v4";
28
24
  * @endpoint GET /v1/people/{personId}/entities/{associationId}
29
25
  * @endpoint GET /v1/people/{personId}/graph
30
26
  * @endpoint GET /v1/people/{personId}/similar
31
- * @endpoint POST /v1/entities/batch
32
- * @endpoint POST /v1/entities/detail/batch
33
27
  * @endpoint POST /v1/entities/lookup/batch
34
28
  * @endpoint POST /v1/entities/lookup/matches
35
29
  * @endpoint POST /v1/entities/natural-search
36
30
  * @endpoint POST /v1/entities/search
37
- * @endpoint POST /v1/people/batch
38
- * @endpoint POST /v1/people/detail/batch
39
31
  * @endpoint POST /v1/people/lookup/batch
40
32
  * @endpoint POST /v1/search/all
33
+ * @endpoint POST /v1/search/natural/entities
41
34
  * @usedBySchema AddressSchema
42
35
  * @contractShape address.state
43
36
  * @contractRole canonical
@@ -14,6 +14,7 @@ type AgentHelpQuestionDefinition = z.infer<typeof AgentHelpQuestionSchemaDefinit
14
14
  *
15
15
  * @openapiSchema AgentHelpQuestion
16
16
  * @endpoint POST /v1/agents/help
17
+ * @endpoint POST /v1/help
17
18
  * @contractShape agent.help-question
18
19
  * @contractRole canonical
19
20
  */
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { HelpScopeSchema } from "../help/scope.js";
4
4
  const AgentHelpQuestionSchemaDefinition = z.object({
5
- /** Optional chat model that answers the question; null uses the configured default. A CLIENT_SECRET (non-admin) caller may only choose a client-secret-eligible model (owned by app.inference.client-secret-eligible-chat-model); an ineligible model is rejected with 422. Admin keys are unrestricted. */
5
+ /** Optional chat model that answers the question; null uses the configured default. A caller without admin authority may only choose an allowlisted model; an ineligible model is rejected with 422. Admin callers are unrestricted. */
6
6
  model: z.string().nullish(),
7
7
  /** The question to answer, in natural language. */
8
8
  question: z.string().min(1),
@@ -14,6 +14,7 @@ const AgentHelpQuestionSchemaDefinition = z.object({
14
14
  *
15
15
  * @openapiSchema AgentHelpQuestion
16
16
  * @endpoint POST /v1/agents/help
17
+ * @endpoint POST /v1/help
17
18
  * @contractShape agent.help-question
18
19
  * @contractRole canonical
19
20
  */
@@ -17,7 +17,6 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
17
17
  LOW: "LOW";
18
18
  MEDIUM: "MEDIUM";
19
19
  }>;
20
- recommendedCommand: z.ZodOptional<z.ZodNullable<z.ZodString>>;
21
20
  }, z.core.$strip>;
22
21
  type AgentHelpDefinition = z.infer<typeof AgentHelpSchemaDefinition>;
23
22
  /**
@@ -25,6 +24,7 @@ type AgentHelpDefinition = z.infer<typeof AgentHelpSchemaDefinition>;
25
24
  *
26
25
  * @openapiSchema AgentHelp
27
26
  * @endpoint POST /v1/agents/help
27
+ * @endpoint POST /v1/help
28
28
  * @contractShape agent.help
29
29
  * @contractRole canonical
30
30
  */
@@ -9,14 +9,13 @@ const AgentHelpSchemaDefinition = z.object({
9
9
  citation: z.array(HelpCitationSchema),
10
10
  /** Confidence the answer is fully supported by the cited corpus. LOW signals an abstention. */
11
11
  confidence: ConfidenceSchema,
12
- /** Canonical CLI/MCP/API command the asker should run, when one is supported by the cited corpus; null when no single command applies or the model abstains. */
13
- recommendedCommand: z.string().nullish(),
14
12
  });
15
13
  /**
16
14
  * Grounded natural-language help answer with citations to specific operations, skills, or completion gates. Unsupported questions abstain (LOW confidence) rather than guess.
17
15
  *
18
16
  * @openapiSchema AgentHelp
19
17
  * @endpoint POST /v1/agents/help
18
+ * @endpoint POST /v1/help
20
19
  * @contractShape agent.help
21
20
  * @contractRole canonical
22
21
  */
@@ -18,6 +18,8 @@ type AgentInstructionDetailDefinition = z.infer<typeof AgentInstructionDetailSch
18
18
  * @openapiSchema AgentInstructionDetail
19
19
  * @endpoint GET /v1/agents/instructions/{kind}/{name}
20
20
  * @endpoint GET /v1/agents/instructions/{kind}/{name}/versions/{version}
21
+ * @endpoint GET /v1/help/instructions/{kind}/{name}
22
+ * @endpoint GET /v1/help/instructions/{kind}/{name}/versions/{version}
21
23
  * @contractShape agent.instruction-detail
22
24
  * @contractRole canonical
23
25
  */
@@ -13,6 +13,8 @@ const AgentInstructionDetailSchemaDefinition = z.object({
13
13
  * @openapiSchema AgentInstructionDetail
14
14
  * @endpoint GET /v1/agents/instructions/{kind}/{name}
15
15
  * @endpoint GET /v1/agents/instructions/{kind}/{name}/versions/{version}
16
+ * @endpoint GET /v1/help/instructions/{kind}/{name}
17
+ * @endpoint GET /v1/help/instructions/{kind}/{name}/versions/{version}
16
18
  * @contractShape agent.instruction-detail
17
19
  * @contractRole canonical
18
20
  */
@@ -5,6 +5,8 @@ import { z } from "zod/v4";
5
5
  * @openapiSchema AgentInstructionKind
6
6
  * @endpoint GET /v1/agents/instructions/{kind}/{name}
7
7
  * @endpoint GET /v1/agents/instructions/{kind}/{name}/versions/{version}
8
+ * @endpoint GET /v1/help/instructions/{kind}/{name}
9
+ * @endpoint GET /v1/help/instructions/{kind}/{name}/versions/{version}
8
10
  * @usedBySchema AgentInstructionSchema
9
11
  * @contractShape agent.instruction-kind
10
12
  * @contractRole canonical
@@ -6,6 +6,8 @@ import { z } from "zod/v4";
6
6
  * @openapiSchema AgentInstructionKind
7
7
  * @endpoint GET /v1/agents/instructions/{kind}/{name}
8
8
  * @endpoint GET /v1/agents/instructions/{kind}/{name}/versions/{version}
9
+ * @endpoint GET /v1/help/instructions/{kind}/{name}
10
+ * @endpoint GET /v1/help/instructions/{kind}/{name}/versions/{version}
9
11
  * @usedBySchema AgentInstructionSchema
10
12
  * @contractShape agent.instruction-kind
11
13
  * @contractRole canonical
@@ -28,6 +28,7 @@ type AgentInstructionManifestDefinition = z.infer<typeof AgentInstructionManifes
28
28
  *
29
29
  * @openapiSchema AgentInstructionManifest
30
30
  * @endpoint GET /v1/agents/instructions/manifest
31
+ * @endpoint GET /v1/help/instructions/manifest
31
32
  * @contractShape agent.instruction-manifest
32
33
  * @contractRole canonical
33
34
  */
@@ -14,6 +14,7 @@ const AgentInstructionManifestSchemaDefinition = z.object({
14
14
  *
15
15
  * @openapiSchema AgentInstructionManifest
16
16
  * @endpoint GET /v1/agents/instructions/manifest
17
+ * @endpoint GET /v1/help/instructions/manifest
17
18
  * @contractShape agent.instruction-manifest
18
19
  * @contractRole canonical
19
20
  */
@@ -9,6 +9,7 @@ type AgentInstructionPointerDefinition = z.infer<typeof AgentInstructionPointerS
9
9
  *
10
10
  * @openapiSchema AgentInstructionPointer
11
11
  * @endpoint GET /v1/agents/instructions/manifest
12
+ * @endpoint GET /v1/help/instructions/manifest
12
13
  * @usedBySchema AgentInstructionManifestSchema
13
14
  * @contractShape agent.instruction-pointer
14
15
  * @contractRole canonical
@@ -11,6 +11,7 @@ const AgentInstructionPointerSchemaDefinition = z.object({
11
11
  *
12
12
  * @openapiSchema AgentInstructionPointer
13
13
  * @endpoint GET /v1/agents/instructions/manifest
14
+ * @endpoint GET /v1/help/instructions/manifest
14
15
  * @usedBySchema AgentInstructionManifestSchema
15
16
  * @contractShape agent.instruction-pointer
16
17
  * @contractRole canonical
@@ -15,6 +15,8 @@ type AgentInstructionDefinition = z.infer<typeof AgentInstructionSchemaDefinitio
15
15
  * @openapiSchema AgentInstruction
16
16
  * @endpoint GET /v1/agents/instructions/{kind}/{name}
17
17
  * @endpoint GET /v1/agents/instructions/{kind}/{name}/versions/{version}
18
+ * @endpoint GET /v1/help/instructions/{kind}/{name}
19
+ * @endpoint GET /v1/help/instructions/{kind}/{name}/versions/{version}
18
20
  * @usedBySchema AgentInstructionDetailSchema
19
21
  * @contractShape agent.instruction
20
22
  * @contractRole canonical
@@ -15,6 +15,8 @@ const AgentInstructionSchemaDefinition = z.object({
15
15
  * @openapiSchema AgentInstruction
16
16
  * @endpoint GET /v1/agents/instructions/{kind}/{name}
17
17
  * @endpoint GET /v1/agents/instructions/{kind}/{name}/versions/{version}
18
+ * @endpoint GET /v1/help/instructions/{kind}/{name}
19
+ * @endpoint GET /v1/help/instructions/{kind}/{name}/versions/{version}
18
20
  * @usedBySchema AgentInstructionDetailSchema
19
21
  * @contractShape agent.instruction
20
22
  * @contractRole canonical
@@ -1,5 +1,5 @@
1
1
  import { z } from "zod/v4";
2
- declare const PersonalApiKeySchemaDefinition: z.ZodObject<{
2
+ declare const ApiKeySchemaDefinition: z.ZodObject<{
3
3
  createdAt: z.ZodISODateTime;
4
4
  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
5
5
  expiresAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
@@ -16,17 +16,17 @@ declare const PersonalApiKeySchemaDefinition: z.ZodObject<{
16
16
  subject: z.ZodString;
17
17
  updatedAt: z.ZodISODateTime;
18
18
  }, z.core.$strip>;
19
- type PersonalApiKeyDefinition = z.infer<typeof PersonalApiKeySchemaDefinition>;
19
+ type ApiKeyDefinition = z.infer<typeof ApiKeySchemaDefinition>;
20
20
  /**
21
- * Personal API-key metadata sourced from Clerk; never contains the key secret
21
+ * Clerk API-key metadata; never contains the key secret
22
22
  *
23
- * @openapiSchema PersonalApiKey
24
- * @endpoint GET /v1/auth/personal-api-key
25
- * @endpoint DELETE /v1/auth/personal-api-key
26
- * @contractShape personal.api-key
23
+ * @openapiSchema ApiKey
24
+ * @endpoint GET /v1/auth/api-key
25
+ * @endpoint DELETE /v1/auth/api-key
26
+ * @contractShape api.key
27
27
  * @contractRole canonical
28
28
  */
29
- export declare const PersonalApiKeySchema: z.ZodType<PersonalApiKeyDefinition>;
30
- export type PersonalApiKey = z.infer<typeof PersonalApiKeySchema>;
29
+ export declare const ApiKeySchema: z.ZodType<ApiKeyDefinition>;
30
+ export type ApiKey = z.infer<typeof ApiKeySchema>;
31
31
  export {};
32
- //# sourceMappingURL=api-key.d.ts.map
32
+ //# sourceMappingURL=key.d.ts.map
@@ -1,6 +1,6 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
- const PersonalApiKeySchemaDefinition = z.object({
3
+ const ApiKeySchemaDefinition = z.object({
4
4
  /** Provider creation timestamp */
5
5
  createdAt: z.iso.datetime({ offset: true }),
6
6
  /** Optional user-visible key description */
@@ -25,13 +25,13 @@ const PersonalApiKeySchemaDefinition = z.object({
25
25
  updatedAt: z.iso.datetime({ offset: true }),
26
26
  });
27
27
  /**
28
- * Personal API-key metadata sourced from Clerk; never contains the key secret
28
+ * Clerk API-key metadata; never contains the key secret
29
29
  *
30
- * @openapiSchema PersonalApiKey
31
- * @endpoint GET /v1/auth/personal-api-key
32
- * @endpoint DELETE /v1/auth/personal-api-key
33
- * @contractShape personal.api-key
30
+ * @openapiSchema ApiKey
31
+ * @endpoint GET /v1/auth/api-key
32
+ * @endpoint DELETE /v1/auth/api-key
33
+ * @contractShape api.key
34
34
  * @contractRole canonical
35
35
  */
36
- export const PersonalApiKeySchema = PersonalApiKeySchemaDefinition;
37
- //# sourceMappingURL=api-key.js.map
36
+ export const ApiKeySchema = ApiKeySchemaDefinition;
37
+ //# sourceMappingURL=key.js.map
@@ -9,6 +9,7 @@ import { z } from "zod/v4";
9
9
  export declare const AuthClientSchema: z.ZodObject<{
10
10
  authorizationServer: z.ZodString;
11
11
  clientId: z.ZodString;
12
+ mcpResource: z.ZodOptional<z.ZodNullable<z.ZodString>>;
12
13
  redirectUri: z.ZodString;
13
14
  resource: z.ZodString;
14
15
  scope: z.ZodArray<z.ZodString>;
@@ -12,6 +12,8 @@ export const AuthClientSchema = z.object({
12
12
  authorizationServer: z.string(),
13
13
  /** Public OAuth client identifier */
14
14
  clientId: z.string(),
15
+ /** OAuth resource indicator accepted for this environment's MCP server */
16
+ mcpResource: z.string().nullish(),
15
17
  /** Registered loopback callback URI template */
16
18
  redirectUri: z.string(),
17
19
  /** OAuth resource indicator accepted by the API */
@@ -4,6 +4,7 @@ declare const AuthProviderCatalogSchemaDefinition: z.ZodObject<{
4
4
  oauthClient: z.ZodOptional<z.ZodNullable<z.ZodObject<{
5
5
  authorizationServer: z.ZodString;
6
6
  clientId: z.ZodString;
7
+ mcpResource: z.ZodOptional<z.ZodNullable<z.ZodString>>;
7
8
  redirectUri: z.ZodString;
8
9
  resource: z.ZodString;
9
10
  scope: z.ZodArray<z.ZodString>;