@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.
- package/README.md +7 -1
- package/dist/address/address.d.ts +1 -8
- package/dist/address/address.js +1 -8
- package/dist/address/association-role.d.ts +1 -8
- package/dist/address/association-role.js +1 -8
- package/dist/address/association.d.ts +1 -8
- package/dist/address/association.js +1 -8
- package/dist/address/city.d.ts +1 -8
- package/dist/address/city.js +1 -8
- package/dist/address/country.d.ts +1 -8
- package/dist/address/country.js +1 -8
- package/dist/address/state.d.ts +1 -8
- package/dist/address/state.js +1 -8
- package/dist/agent/help-question.d.ts +1 -0
- package/dist/agent/help-question.js +2 -1
- package/dist/agent/help.d.ts +1 -1
- package/dist/agent/help.js +1 -2
- package/dist/agent/instruction-detail.d.ts +2 -0
- package/dist/agent/instruction-detail.js +2 -0
- package/dist/agent/instruction-kind.d.ts +2 -0
- package/dist/agent/instruction-kind.js +2 -0
- package/dist/agent/instruction-manifest.d.ts +1 -0
- package/dist/agent/instruction-manifest.js +1 -0
- package/dist/agent/instruction-pointer.d.ts +1 -0
- package/dist/agent/instruction-pointer.js +1 -0
- package/dist/agent/instruction.d.ts +2 -0
- package/dist/agent/instruction.js +2 -0
- package/dist/{personal/api-key.d.ts → api/key.d.ts} +10 -10
- package/dist/{personal/api-key.js → api/key.js} +8 -8
- package/dist/auth/client.d.ts +1 -0
- package/dist/auth/client.js +2 -0
- package/dist/auth/provider-catalog.d.ts +1 -0
- package/dist/billing/additional-usage-funding-type.d.ts +16 -0
- package/dist/billing/additional-usage-funding-type.js +13 -0
- package/dist/billing/additional-usage-meter.d.ts +28 -0
- package/dist/billing/additional-usage-meter.js +20 -0
- package/dist/billing/additional-usage-type.d.ts +23 -0
- package/dist/billing/additional-usage-type.js +23 -0
- package/dist/billing/additional-usage.d.ts +38 -0
- package/dist/billing/additional-usage.js +35 -0
- package/dist/billing/catalog-additional-usage.d.ts +27 -0
- package/dist/billing/catalog-additional-usage.js +19 -0
- package/dist/billing/catalog-allowance.d.ts +26 -0
- package/dist/billing/catalog-allowance.js +25 -0
- package/dist/billing/catalog-credit-pack.d.ts +24 -0
- package/dist/billing/catalog-credit-pack.js +19 -0
- package/dist/billing/catalog-plan.d.ts +34 -0
- package/dist/billing/catalog-plan.js +25 -0
- package/dist/billing/catalog-tier.d.ts +32 -0
- package/dist/billing/catalog-tier.js +21 -0
- package/dist/billing/catalog.d.ts +63 -0
- package/dist/billing/catalog.js +24 -0
- package/dist/billing/checkout-mutation.d.ts +23 -0
- package/dist/billing/checkout-mutation.js +17 -0
- package/dist/billing/checkout.d.ts +25 -0
- package/dist/billing/checkout.js +18 -0
- package/dist/billing/credit-pack-type.d.ts +18 -0
- package/dist/billing/credit-pack-type.js +13 -0
- package/dist/billing/plan-type.d.ts +24 -0
- package/dist/billing/plan-type.js +24 -0
- package/dist/billing/portal.d.ts +17 -0
- package/dist/billing/portal.js +15 -0
- package/dist/billing/subscription.d.ts +150 -0
- package/dist/billing/subscription.js +36 -0
- package/dist/blog/post-type.d.ts +0 -1
- package/dist/blog/post-type.js +0 -1
- package/dist/blog/post.d.ts +0 -1
- package/dist/blog/post.js +1 -2
- package/dist/classification/classification.d.ts +1 -6
- package/dist/classification/classification.js +1 -6
- package/dist/cli/authorization-delivery.d.ts +1 -1
- package/dist/cli/authorization-delivery.js +2 -2
- package/dist/cli/authorization-poll.d.ts +1 -1
- package/dist/cli/authorization-terminal-reason.d.ts +1 -1
- package/dist/cli/authorization-terminal-reason.js +1 -1
- package/dist/cli/authorization.d.ts +1 -1
- package/dist/confidence/confidence.d.ts +3 -4
- package/dist/confidence/confidence.js +3 -4
- package/dist/content/compliance.d.ts +2 -5
- package/dist/content/compliance.js +2 -5
- package/dist/content/embedding-match.d.ts +2 -9
- package/dist/content/embedding-match.js +2 -9
- package/dist/content/source-type.d.ts +2 -9
- package/dist/content/source-type.js +2 -9
- package/dist/datasource/agent-identity.d.ts +1 -1
- package/dist/datasource/agent-identity.js +1 -1
- package/dist/datasource/data-source-type.d.ts +1 -1
- package/dist/datasource/data-source-type.js +1 -1
- package/dist/datasource/field-provenance.d.ts +1 -1
- package/dist/datasource/field-provenance.js +1 -1
- package/dist/datasource/provenance-actor-type.d.ts +1 -1
- package/dist/datasource/provenance-actor-type.js +1 -1
- package/dist/datasource/provenance-actor.d.ts +1 -1
- package/dist/datasource/provenance-actor.js +1 -1
- package/dist/datasource/provenance-field-change.d.ts +1 -1
- package/dist/datasource/provenance-field-change.js +1 -1
- package/dist/datasource/provenance-operation.d.ts +1 -1
- package/dist/datasource/provenance-operation.js +1 -1
- package/dist/datasource/provenance-source.d.ts +1 -1
- package/dist/datasource/provenance-source.js +1 -1
- package/dist/datasource/provenance-status.d.ts +1 -1
- package/dist/datasource/provenance-status.js +1 -1
- package/dist/datasource/source-metadata.d.ts +3 -26
- package/dist/datasource/source-metadata.js +3 -26
- package/dist/datasource/tracked-provenance-table.d.ts +1 -1
- package/dist/datasource/tracked-provenance-table.js +1 -1
- package/dist/decimal/range.d.ts +2 -4
- package/dist/decimal/range.js +2 -4
- package/dist/employee/count.d.ts +1 -1
- package/dist/employee/count.js +1 -1
- package/dist/entity/accelerator-participation.d.ts +1 -6
- package/dist/entity/accelerator-participation.js +1 -5
- package/dist/entity/acquisition.d.ts +0 -2
- package/dist/entity/alias-type.d.ts +5 -11
- package/dist/entity/alias-type.js +5 -11
- package/dist/entity/classification.d.ts +1 -5
- package/dist/entity/classification.js +1 -5
- package/dist/entity/comparison-signals.d.ts +0 -3
- package/dist/entity/comparison-signals.js +0 -3
- package/dist/entity/detail-batch.d.ts +0 -1
- package/dist/entity/detail-batch.js +0 -1
- package/dist/entity/detail.d.ts +4 -54
- package/dist/entity/detail.js +0 -3
- package/dist/entity/enrichment.d.ts +2 -5
- package/dist/entity/enrichment.js +1 -5
- package/dist/entity/entity.d.ts +6 -13
- package/dist/entity/entity.js +6 -14
- package/dist/entity/filter-count-meta.d.ts +0 -1
- package/dist/entity/filter-count-meta.js +0 -1
- package/dist/entity/filter-count-result.d.ts +0 -1
- package/dist/entity/filter-count-result.js +0 -1
- package/dist/entity/filter-logo-option.d.ts +3 -3
- package/dist/entity/filter-logo-option.js +2 -2
- package/dist/entity/filter-search-result.d.ts +0 -1
- package/dist/entity/filter-search-result.js +0 -1
- package/dist/entity/filter-search.d.ts +10 -3
- package/dist/entity/filter.d.ts +11 -4
- package/dist/entity/filter.js +4 -3
- package/dist/entity/filters-counts-param.d.ts +19 -0
- package/dist/entity/filters-counts-param.js +23 -0
- package/dist/entity/funding-detail.d.ts +2 -5
- package/dist/entity/funding-detail.js +3 -5
- package/dist/entity/fundraise-filter-criteria.d.ts +1 -1
- package/dist/entity/fundraise-filter-criteria.js +1 -1
- package/dist/entity/fundraise-investor-activity.d.ts +1 -1
- package/dist/entity/fundraise-investor-activity.js +1 -1
- package/dist/entity/fundraise-investor-join.d.ts +2 -2
- package/dist/entity/fundraise-investor-join.js +3 -3
- package/dist/entity/fundraise-transaction-entity.d.ts +2 -6
- package/dist/entity/fundraise-transaction-entity.js +1 -5
- package/dist/entity/fundraise-transaction.d.ts +2 -6
- package/dist/entity/fundraise-transaction.js +1 -5
- package/dist/entity/fundraise.d.ts +1 -7
- package/dist/entity/fundraise.js +1 -7
- package/dist/entity/image.d.ts +5 -11
- package/dist/entity/image.js +5 -11
- package/dist/entity/investments-param.js +1 -1
- package/dist/entity/investor-participation.d.ts +4 -51
- package/dist/entity/investors-param.js +1 -1
- package/dist/entity/list-filter.d.ts +12 -4
- package/dist/entity/list-filter.js +6 -4
- package/dist/entity/list-quality-gate.d.ts +1 -2
- package/dist/entity/list-quality-gate.js +1 -2
- package/dist/entity/list-research.d.ts +1 -11
- package/dist/entity/list-research.js +1 -3
- package/dist/entity/list-summary.d.ts +3 -3
- package/dist/entity/list.d.ts +5 -14
- package/dist/entity/list.js +1 -3
- package/dist/entity/logo-type.d.ts +1 -1
- package/dist/entity/logo-type.js +1 -1
- package/dist/entity/lookup-batch-param.d.ts +18 -0
- package/dist/entity/{detail-batch-param.js → lookup-batch-param.js} +7 -7
- package/dist/entity/lookup-param.js +3 -3
- package/dist/entity/name-alias-entity-alias-type.d.ts +5 -11
- package/dist/entity/name-alias-entity-alias-type.js +5 -11
- package/dist/entity/name-alias-person-alias-type.d.ts +1 -7
- package/dist/entity/name-alias-person-alias-type.js +1 -7
- package/dist/entity/natural-search.d.ts +11 -3
- package/dist/entity/natural-search.js +1 -0
- package/dist/entity/operating-status.d.ts +28 -0
- package/dist/entity/operating-status.js +28 -0
- package/dist/entity/people-param.d.ts +27 -0
- package/dist/entity/people-param.js +34 -0
- package/dist/entity/person-association.d.ts +0 -9
- package/dist/entity/person-association.js +0 -10
- package/dist/entity/person-owner.d.ts +1 -2
- package/dist/entity/person-owner.js +1 -2
- package/dist/entity/relationship.d.ts +0 -4
- package/dist/entity/relationship.js +0 -3
- package/dist/entity/research-detail.d.ts +3 -14
- package/dist/entity/research-detail.js +3 -11
- package/dist/entity/research-fact-value.d.ts +1 -1
- package/dist/entity/research-fact-value.js +1 -1
- package/dist/entity/research-snippet.d.ts +2 -9
- package/dist/entity/research-snippet.js +2 -12
- package/dist/entity/research-value-type.d.ts +4 -8
- package/dist/entity/research-value-type.js +4 -8
- package/dist/entity/research.d.ts +0 -15
- package/dist/entity/research.js +0 -3
- package/dist/entity/resolution.d.ts +4 -51
- package/dist/entity/search-param.js +2 -2
- package/dist/entity/similarity-context.d.ts +0 -1
- package/dist/entity/similarity-context.js +0 -1
- package/dist/entity/similarity-origin.d.ts +0 -1
- package/dist/entity/similarity-origin.js +0 -1
- package/dist/entity/similarity-result.d.ts +4 -13
- package/dist/entity/similarity-result.js +0 -1
- package/dist/entity/sitemap.d.ts +5 -11
- package/dist/entity/sitemap.js +5 -11
- package/dist/entity/suggestion-result.d.ts +4 -12
- package/dist/entity/suggestion.d.ts +4 -12
- package/dist/entity/tag-count.d.ts +0 -1
- package/dist/entity/tag-count.js +0 -1
- package/dist/entity/tag.d.ts +1 -7
- package/dist/entity/tag.js +1 -7
- package/dist/entity/text-bundle.d.ts +2 -9
- package/dist/entity/text-bundle.js +2 -9
- package/dist/entity/url-crawl-cdn-provider.d.ts +1 -10
- package/dist/entity/url-crawl-cdn-provider.js +1 -10
- package/dist/entity/url-crawl-render-mode.d.ts +1 -10
- package/dist/entity/url-crawl-render-mode.js +1 -10
- package/dist/entity/url-link.d.ts +1 -10
- package/dist/entity/url-link.js +1 -10
- package/dist/entity/url-type.d.ts +1 -10
- package/dist/entity/url-type.js +1 -10
- package/dist/entity/valuation-data-confidence.d.ts +1 -22
- package/dist/entity/valuation-data-confidence.js +1 -22
- package/dist/federated/search.d.ts +10 -36
- package/dist/funding/stage.d.ts +1 -5
- package/dist/funding/stage.js +1 -5
- package/dist/fundraise/data-confidence.d.ts +1 -5
- package/dist/fundraise/data-confidence.js +1 -5
- package/dist/fundraise/financial-instrument-type.d.ts +2 -2
- package/dist/fundraise/financial-instrument-type.js +2 -2
- package/dist/fundraise/investment-attribution-type.d.ts +2 -9
- package/dist/fundraise/investment-attribution-type.js +2 -9
- package/dist/fundraise/investment-attribution.d.ts +2 -9
- package/dist/fundraise/investment-attribution.js +2 -9
- package/dist/help/citation.d.ts +1 -0
- package/dist/help/citation.js +1 -0
- package/dist/help/scope.d.ts +1 -0
- package/dist/help/scope.js +1 -0
- package/dist/help/source-type.d.ts +1 -0
- package/dist/help/source-type.js +1 -0
- package/dist/http/problem-detail.d.ts +26 -1
- package/dist/http/problem-detail.js +84 -1
- package/dist/identification/candidate.d.ts +37 -0
- package/dist/identification/candidate.js +20 -0
- package/dist/identification/identification.d.ts +77 -0
- package/dist/identification/identification.js +28 -0
- package/dist/identification/subject.d.ts +23 -0
- package/dist/identification/subject.js +27 -0
- package/dist/int/range.d.ts +2 -4
- package/dist/int/range.js +2 -4
- package/dist/investor/activity-filter.d.ts +2 -2
- package/dist/investor/activity-filter.js +2 -2
- package/dist/link/search.d.ts +10 -36
- package/dist/location/directory-entry.d.ts +1 -2
- package/dist/location/directory-entry.js +1 -2
- package/dist/location/identifier.d.ts +1 -1
- package/dist/location/identifier.js +1 -1
- package/dist/location/scope.d.ts +1 -1
- package/dist/location/scope.js +1 -1
- package/dist/location/sitemap.d.ts +81 -18
- package/dist/location/sitemap.js +5 -4
- package/dist/media/object-type.d.ts +3 -3
- package/dist/media/object-type.js +3 -3
- package/dist/media/slot.d.ts +18 -0
- package/dist/media/slot.js +14 -0
- package/dist/media/upload.d.ts +3 -3
- package/dist/media/upload.js +3 -3
- package/dist/natural/search-result.d.ts +9 -16
- package/dist/natural/search-result.js +1 -0
- package/dist/natural/search.d.ts +2 -0
- package/dist/natural/search.js +3 -1
- package/dist/news/detail.d.ts +14 -24
- package/dist/news/detail.js +10 -12
- package/dist/news/match-status.d.ts +20 -0
- package/dist/news/match-status.js +15 -0
- package/dist/news/news.d.ts +0 -10
- package/dist/news/news.js +0 -10
- package/dist/news/resolved-entity-link.d.ts +7 -4
- package/dist/news/resolved-entity-link.js +3 -4
- package/dist/news/resolved-person-link.d.ts +6 -3
- package/dist/news/resolved-person-link.js +2 -3
- package/dist/news/source-url-conflict.js +1 -1
- package/dist/openapi-component-manifest.js +78 -38
- package/dist/pageable/object.d.ts +15 -29
- package/dist/pageable/object.js +15 -29
- package/dist/pagination/schemas.d.ts +49 -520
- package/dist/pagination/schemas.js +23 -100
- package/dist/person/alias-type.d.ts +1 -7
- package/dist/person/alias-type.js +1 -7
- package/dist/person/detail.d.ts +0 -30
- package/dist/person/detail.js +0 -7
- package/dist/person/enrichment.d.ts +0 -6
- package/dist/person/enrichment.js +0 -6
- package/dist/person/filter.d.ts +2 -1
- package/dist/person/filter.js +3 -1
- package/dist/person/graph-career-context.d.ts +3 -5
- package/dist/person/graph-co-investor.d.ts +0 -1
- package/dist/person/graph-similar-entity.d.ts +1 -1
- package/dist/person/graph.d.ts +4 -8
- package/dist/person/image.d.ts +1 -7
- package/dist/person/image.js +1 -7
- package/dist/person/invested-company.d.ts +1 -8
- package/dist/person/invested-company.js +1 -7
- package/dist/person/investment.d.ts +1 -9
- package/dist/person/investment.js +1 -7
- package/dist/person/investor-participation.d.ts +0 -28
- package/dist/person/list-array-filter.d.ts +1 -1
- package/dist/person/list-array-filter.js +1 -1
- package/dist/person/lookup-batch-param.d.ts +18 -0
- package/dist/person/lookup-batch-param.js +21 -0
- package/dist/person/{detail-batch.d.ts → lookup-batch.d.ts} +7 -8
- package/dist/person/{detail-batch.js → lookup-batch.js} +5 -6
- package/dist/person/lookup-param.js +1 -1
- package/dist/person/natural-search-result.d.ts +3 -18
- package/dist/person/natural-search-result.js +1 -0
- package/dist/person/natural-search.d.ts +2 -0
- package/dist/person/natural-search.js +1 -0
- package/dist/person/person.d.ts +1 -16
- package/dist/person/person.js +1 -9
- package/dist/person/search-interpretation.d.ts +2 -0
- package/dist/person/search-interpretation.js +1 -0
- package/dist/person/search-param.js +2 -2
- package/dist/person/similarity-result.d.ts +0 -21
- package/dist/problem/type.d.ts +1 -0
- package/dist/problem/type.js +1 -0
- package/dist/publication/facet.d.ts +29 -0
- package/dist/publication/facet.js +22 -0
- package/dist/publication/publication.d.ts +0 -1
- package/dist/publication/publication.js +1 -2
- package/dist/publication/relation.d.ts +0 -1
- package/dist/publication/relation.js +0 -1
- package/dist/publication/type.d.ts +3 -1
- package/dist/publication/type.js +3 -1
- package/dist/relationship/direction.d.ts +1 -1
- package/dist/relationship/direction.js +1 -1
- package/dist/research/allowance-usage.d.ts +81 -0
- package/dist/research/allowance-usage.js +20 -0
- package/dist/research/allowance.d.ts +20 -0
- package/dist/research/allowance.js +20 -0
- package/dist/research/derived-bucket.d.ts +3 -7
- package/dist/research/derived-bucket.js +3 -7
- package/dist/research/derived-range.d.ts +3 -7
- package/dist/research/derived-range.js +3 -7
- package/dist/resolved/handle.d.ts +2 -1
- package/dist/resolved/handle.js +2 -1
- package/dist/round/label.d.ts +2 -9
- package/dist/round/label.js +2 -9
- package/dist/search/duplicate-candidate-score.d.ts +1 -0
- package/dist/search/duplicate-candidate-score.js +2 -1
- package/dist/search/hit.d.ts +1 -1
- package/dist/search/hit.js +1 -1
- package/dist/search/interpretation.d.ts +5 -4
- package/dist/search/interpretation.js +1 -0
- package/dist/search/mode-execution.d.ts +2 -0
- package/dist/search/mode-execution.js +2 -0
- package/dist/search/mode.d.ts +2 -1
- package/dist/search/mode.js +2 -1
- package/dist/search/ordering-entity-filter-sortable.d.ts +1 -0
- package/dist/search/ordering-entity-filter-sortable.js +1 -0
- package/dist/search/ordering-person-sort-field.d.ts +1 -0
- package/dist/search/ordering-person-sort-field.js +1 -0
- package/dist/search/relevance.d.ts +2 -0
- package/dist/search/relevance.js +2 -0
- package/dist/search/search.d.ts +1 -1
- package/dist/search/search.js +1 -1
- package/dist/sitemap/url-slot.d.ts +0 -1
- package/dist/sitemap/url-slot.js +0 -1
- package/dist/sort/object.d.ts +15 -29
- package/dist/sort/object.js +15 -29
- package/dist/sort/order-entity-filter-sortable.d.ts +1 -0
- package/dist/sort/order-entity-filter-sortable.js +1 -0
- package/dist/sort/order-person-sort-field.d.ts +1 -0
- package/dist/sort/order-person-sort-field.js +1 -0
- package/dist/source/document-list.d.ts +1 -1
- package/dist/source/document-list.js +1 -1
- package/dist/stage/frequency.d.ts +1 -1
- package/dist/stage/frequency.js +1 -1
- package/dist/standardized/classification.d.ts +1 -5
- package/dist/standardized/classification.js +1 -5
- package/dist/unique/id-owner-scope.d.ts +1 -0
- package/dist/unique/id-owner-scope.js +1 -0
- package/dist/unique/id-type-alias.d.ts +1 -0
- package/dist/unique/id-type-alias.js +1 -0
- package/dist/unique/id-type.d.ts +1 -3
- package/dist/unique/id-type.js +1 -3
- package/dist/unique/id.d.ts +1 -3
- package/dist/unique/id.js +1 -3
- package/dist/url/match-mode.d.ts +1 -2
- package/dist/url/match-mode.js +1 -2
- package/dist/url/slug-redirect.d.ts +1 -3
- package/dist/url/slug-redirect.js +1 -3
- package/dist/url/type-alias.d.ts +2 -2
- package/dist/url/type-alias.js +2 -2
- package/dist/web/search.d.ts +1 -1
- package/dist/web/search.js +1 -1
- package/package.json +1 -1
- package/dist/entity/batch-param.d.ts +0 -22
- package/dist/entity/batch-param.js +0 -24
- package/dist/entity/detail-batch-param.d.ts +0 -18
- package/dist/entity/detail-similar-param.d.ts +0 -22
- package/dist/entity/detail-similar-param.js +0 -33
- package/dist/entity/filter-count.d.ts +0 -20
- package/dist/entity/filter-count.js +0 -22
- package/dist/news/filter.d.ts +0 -27
- package/dist/news/filter.js +0 -31
- package/dist/person/batch-param.d.ts +0 -27
- package/dist/person/batch-param.js +0 -38
- package/dist/publication/filter.d.ts +0 -35
- package/dist/publication/filter.js +0 -27
- package/dist/publication/search-interpretation.d.ts +0 -48
- package/dist/publication/search-interpretation.js +0 -30
- package/dist/publication/search-result.d.ts +0 -94
- package/dist/publication/search-result.js +0 -22
- package/dist/publication/sort-field.d.ts +0 -25
- package/dist/publication/sort-field.js +0 -25
- package/dist/sort/order-publication-sort-field.d.ts +0 -31
- package/dist/sort/order-publication-sort-field.js +0 -22
- package/dist/sort/spec-publication-sort-field.d.ts +0 -26
- 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
|
-
|
|
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
|
package/dist/address/address.js
CHANGED
|
@@ -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
|
package/dist/address/city.d.ts
CHANGED
|
@@ -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
|
package/dist/address/city.js
CHANGED
|
@@ -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
|
package/dist/address/country.js
CHANGED
|
@@ -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
|
package/dist/address/state.d.ts
CHANGED
|
@@ -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
|
package/dist/address/state.js
CHANGED
|
@@ -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
|
|
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
|
*/
|
package/dist/agent/help.d.ts
CHANGED
|
@@ -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
|
*/
|
package/dist/agent/help.js
CHANGED
|
@@ -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
|
|
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
|
|
19
|
+
type ApiKeyDefinition = z.infer<typeof ApiKeySchemaDefinition>;
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Clerk API-key metadata; never contains the key secret
|
|
22
22
|
*
|
|
23
|
-
* @openapiSchema
|
|
24
|
-
* @endpoint GET /v1/auth/
|
|
25
|
-
* @endpoint DELETE /v1/auth/
|
|
26
|
-
* @contractShape
|
|
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
|
|
30
|
-
export type
|
|
29
|
+
export declare const ApiKeySchema: z.ZodType<ApiKeyDefinition>;
|
|
30
|
+
export type ApiKey = z.infer<typeof ApiKeySchema>;
|
|
31
31
|
export {};
|
|
32
|
-
//# sourceMappingURL=
|
|
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
|
|
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
|
-
*
|
|
28
|
+
* Clerk API-key metadata; never contains the key secret
|
|
29
29
|
*
|
|
30
|
-
* @openapiSchema
|
|
31
|
-
* @endpoint GET /v1/auth/
|
|
32
|
-
* @endpoint DELETE /v1/auth/
|
|
33
|
-
* @contractShape
|
|
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
|
|
37
|
-
//# sourceMappingURL=
|
|
36
|
+
export const ApiKeySchema = ApiKeySchemaDefinition;
|
|
37
|
+
//# sourceMappingURL=key.js.map
|
package/dist/auth/client.d.ts
CHANGED
|
@@ -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>;
|
package/dist/auth/client.js
CHANGED
|
@@ -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>;
|