@aventurevc/api-schemas 0.8.275 → 0.8.277

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.
@@ -6,7 +6,7 @@ import { EntityFundingDetailSchema } from "./funding-detail.js";
6
6
  import { EntityTextBundleSchema } from "./text-bundle.js";
7
7
  import { EntityUrlLinkSchema } from "./url-link.js";
8
8
  const EntityEnrichmentSchemaDefinition = z.object({
9
- /** Current addresses. Full-detail search carries only the headquarters row (headquartersAddressId); GET /v1/entities/{entityId}/addresses lists every row. */
9
+ /** Current addresses. List rows carry bounded current locations for named roles, identification evidence, and card display, not every office or association history. Single-detail reads retain all current locations and their association history. Full-detail search carries only the headquarters row (headquartersAddressId); GET /v1/entities/{entityId}/addresses lists every row. */
10
10
  address: z.array(AddressSchema),
11
11
  /** Entity classifications. Single-detail and full-detail batch reads include history; list, default batch, and similar-entity reads may return only current classifications. Use GET /v1/entities/{entityId}/classifications?includeInactive=true for the full history. */
12
12
  classification: EntityClassificationSchema,
@@ -1180,7 +1180,7 @@ type EntityListDefinition = z.infer<typeof EntityListSchemaDefinition>;
1180
1180
  export interface EntityListSchemaInput extends z.input<typeof EntityListSchemaDefinition> {
1181
1181
  }
1182
1182
  /**
1183
- * Narrow entity row for list and batch-list reads. Keeps core identity, enrichment, governed research detail, accelerator participation, and fundraise rounds while omitting detail-only relationship, newsArticle, person, sitemap, and research snippet sections. Classification enrichment is current-only on list rows; use the entity classifications subresource with includeInactive=true to audit historical joins.
1183
+ * Narrow entity row for list and batch-list reads. Keeps core identity, enrichment, governed research detail, accelerator participation, and fundraise rounds while omitting detail-only relationship, newsArticle, person, sitemap, and research snippet sections. Classification enrichment is current-only on list rows; use the entity classifications subresource with includeInactive=true to audit historical joins. Addresses are bounded current-location samples, not a complete office inventory; use the entity addresses subresource to list every office and association.
1184
1184
  *
1185
1185
  * @openapiSchema EntityList
1186
1186
  * @endpoint GET /v1/entities
@@ -24,7 +24,7 @@ const EntityListSchemaDefinition = z.object({
24
24
  semanticMatch: ContentEmbeddingMatchSchema.nullish(),
25
25
  });
26
26
  /**
27
- * Narrow entity row for list and batch-list reads. Keeps core identity, enrichment, governed research detail, accelerator participation, and fundraise rounds while omitting detail-only relationship, newsArticle, person, sitemap, and research snippet sections. Classification enrichment is current-only on list rows; use the entity classifications subresource with includeInactive=true to audit historical joins.
27
+ * Narrow entity row for list and batch-list reads. Keeps core identity, enrichment, governed research detail, accelerator participation, and fundraise rounds while omitting detail-only relationship, newsArticle, person, sitemap, and research snippet sections. Classification enrichment is current-only on list rows; use the entity classifications subresource with includeInactive=true to audit historical joins. Addresses are bounded current-location samples, not a complete office inventory; use the entity addresses subresource to list every office and association.
28
28
  *
29
29
  * @openapiSchema EntityList
30
30
  * @endpoint GET /v1/entities
@@ -139,7 +139,7 @@ const ProblemDetailSchemaDefinition = z.object({
139
139
  "news_similarity_embedding_unavailable",
140
140
  /** The web search provider is not configured for this environment. Agent action: stop; admin/ops must configure the provider key before this endpoint will succeed. */
141
141
  "search_provider_not_configured",
142
- /** Search provider call failed. Agent action: inspect detail and source. Provider credential or credit refusals (401, 402, or 407) are terminal: restore the provider credential or credits before retrying. Other transient provider outages may be retried according to Retry-After. */
142
+ /** Search provider call failed. Agent action: inspect detail and source. Provider credential or credit refusals (401, 402, or 407) are terminal: restore the provider credential or credits before retrying. TERMINAL: every provider failed this query; record the outage, never resend. TRANSIENT: retry once per Retry-After. */
143
143
  "search_provider_error",
144
144
  /** aVenture stopped waiting for a web search the provider is still running; the search keeps running and its finished result is stored. Agent action: retry the same request, after retryAfterSeconds when present (also in the Retry-After header); this is not a provider failure. */
145
145
  "search_still_running",
@@ -0,0 +1,27 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * How a logo-accuracy outcome was reached
4
+ *
5
+ * @openapiSchema LogoAccuracyMethod
6
+ * @endpoint GET /v1/entities/{entityId}/logo
7
+ * @endpoint GET /v1/news/{newsId}/thumbnail
8
+ * @endpoint GET /v1/people/{personId}/photo
9
+ * @usedBySchema LogoAccuracySchema
10
+ * @contractShape logo.accuracy-method
11
+ * @contractRole canonical
12
+ */
13
+ export declare const LogoAccuracyMethodSchema: z.ZodUnion<readonly [z.ZodEnum<{
14
+ OPERATOR_REVIEW: "OPERATOR_REVIEW";
15
+ PERCEPTUAL_HASH: "PERCEPTUAL_HASH";
16
+ REFERENCE_UNAVAILABLE: "REFERENCE_UNAVAILABLE";
17
+ VISION: "VISION";
18
+ }>, z.ZodString]> & {
19
+ enum: {
20
+ OPERATOR_REVIEW: "OPERATOR_REVIEW";
21
+ PERCEPTUAL_HASH: "PERCEPTUAL_HASH";
22
+ REFERENCE_UNAVAILABLE: "REFERENCE_UNAVAILABLE";
23
+ VISION: "VISION";
24
+ };
25
+ };
26
+ export type LogoAccuracyMethod = z.infer<typeof LogoAccuracyMethodSchema>;
27
+ //# sourceMappingURL=accuracy-method.d.ts.map
@@ -0,0 +1,21 @@
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
+ import { z } from "zod/v4";
3
+ const LogoAccuracyMethodSchemaKnownMembers = z.enum([
4
+ "PERCEPTUAL_HASH",
5
+ "VISION",
6
+ "OPERATOR_REVIEW",
7
+ "REFERENCE_UNAVAILABLE",
8
+ ]);
9
+ /**
10
+ * How a logo-accuracy outcome was reached
11
+ *
12
+ * @openapiSchema LogoAccuracyMethod
13
+ * @endpoint GET /v1/entities/{entityId}/logo
14
+ * @endpoint GET /v1/news/{newsId}/thumbnail
15
+ * @endpoint GET /v1/people/{personId}/photo
16
+ * @usedBySchema LogoAccuracySchema
17
+ * @contractShape logo.accuracy-method
18
+ * @contractRole canonical
19
+ */
20
+ export const LogoAccuracyMethodSchema = Object.assign(z.union([LogoAccuracyMethodSchemaKnownMembers, z.string()]), { enum: LogoAccuracyMethodSchemaKnownMembers.enum });
21
+ //# sourceMappingURL=accuracy-method.js.map
@@ -17,12 +17,19 @@ export declare const LogoAccuracySchema: z.ZodObject<{
17
17
  LOW: "LOW";
18
18
  MEDIUM: "MEDIUM";
19
19
  }>;
20
- method: z.ZodEnum<{
20
+ method: z.ZodUnion<readonly [z.ZodEnum<{
21
21
  OPERATOR_REVIEW: "OPERATOR_REVIEW";
22
22
  PERCEPTUAL_HASH: "PERCEPTUAL_HASH";
23
23
  REFERENCE_UNAVAILABLE: "REFERENCE_UNAVAILABLE";
24
24
  VISION: "VISION";
25
- }>;
25
+ }>, z.ZodString]> & {
26
+ enum: {
27
+ OPERATOR_REVIEW: "OPERATOR_REVIEW";
28
+ PERCEPTUAL_HASH: "PERCEPTUAL_HASH";
29
+ REFERENCE_UNAVAILABLE: "REFERENCE_UNAVAILABLE";
30
+ VISION: "VISION";
31
+ };
32
+ };
26
33
  outcome: z.ZodEnum<{
27
34
  INSUFFICIENT: "INSUFFICIENT";
28
35
  MATCH: "MATCH";
@@ -1,6 +1,7 @@
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
3
  import { ConfidenceSchema } from "../confidence/confidence.js";
4
+ import { LogoAccuracyMethodSchema } from "./accuracy-method.js";
4
5
  import { LogoAccuracyReferenceSchema } from "./accuracy-reference.js";
5
6
  /**
6
7
  * Read-only assessment of whether a stored logo/photo depicts the target's own brand, decided from visible features of the stored mark versus the target's own reference marks
@@ -19,7 +20,7 @@ export const LogoAccuracySchema = z.object({
19
20
  /** Confidence in the outcome */
20
21
  confidence: ConfidenceSchema,
21
22
  /** How the outcome was reached */
22
- method: z.enum(["PERCEPTUAL_HASH", "VISION", "OPERATOR_REVIEW", "REFERENCE_UNAVAILABLE"]),
23
+ method: LogoAccuracyMethodSchema,
23
24
  /** Whether the candidate mark matches the target's own brand */
24
25
  outcome: z.enum(["MATCH", "MISMATCH", "INSUFFICIENT"]),
25
26
  /** Reference marks fetched from the target's own surfaces, each with its perceptual-hash distance to the candidate. The deciding deterministic distance is the smallest entry */
@@ -81,7 +81,7 @@ type LookupJobMutationDefinition = z.infer<typeof LookupJobMutationSchemaDefinit
81
81
  export interface LookupJobMutationSchemaInput extends z.input<typeof LookupJobMutationSchemaDefinition> {
82
82
  }
83
83
  /**
84
- * The article whose companies and people a lookup identifies. Send sourceUrl, sourceNewsId, or both; POST /v1/lookup/mentions also reads a recorded sourceDocumentId alone; lookup-only bulk jobs and POST /v1/lookup/mentions also accept mention instead. A job filed by Prefer: respond-async on GET /v1/lookup or POST /v1/entities/lookup carries that request's subject instead.
84
+ * The article whose companies and people a lookup identifies. Send sourceUrl, sourceNewsId, or both; POST /v1/lookup/mentions also reads a recorded sourceDocumentId alone; lookup-only bulk jobs and POST /v1/lookup/mentions also accept mention instead. A job filed by Prefer: respond-async on POST /v1/lookup with kind in the JSON body carries that request's subject instead.
85
85
  *
86
86
  * @openapiSchema LookupJobMutation
87
87
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -15,11 +15,11 @@ const LookupJobMutationSchemaDefinition = z.object({
15
15
  sourceNewsId: z.int().nullish(),
16
16
  /** URL of the article; read from aVenture news when stored there, otherwise fetched. */
17
17
  sourceUrl: z.string().max(2000).nullish(),
18
- /** Read-only: the subject of a GET or POST /v1/lookup or POST /v1/entities/lookup request sent with Prefer: respond-async, rolled over from a signed-in live lookup, or handed off for pending filing. This job preserves the route's options. Requests to create a job or read mentions must omit it. */
18
+ /** Read-only: the subject of a POST /v1/lookup request with kind in the JSON body, sent with Prefer: respond-async, rolled over from a signed-in live lookup, or handed off for pending filing. This job preserves the route's options. Requests to create a job or read mentions must omit it. */
19
19
  subject: IdentificationSubjectSchema.nullish(),
20
20
  });
21
21
  /**
22
- * The article whose companies and people a lookup identifies. Send sourceUrl, sourceNewsId, or both; POST /v1/lookup/mentions also reads a recorded sourceDocumentId alone; lookup-only bulk jobs and POST /v1/lookup/mentions also accept mention instead. A job filed by Prefer: respond-async on GET /v1/lookup or POST /v1/entities/lookup carries that request's subject instead.
22
+ * The article whose companies and people a lookup identifies. Send sourceUrl, sourceNewsId, or both; POST /v1/lookup/mentions also reads a recorded sourceDocumentId alone; lookup-only bulk jobs and POST /v1/lookup/mentions also accept mention instead. A job filed by Prefer: respond-async on POST /v1/lookup with kind in the JSON body carries that request's subject instead.
23
23
  *
24
24
  * @openapiSchema LookupJobMutation
25
25
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -9,7 +9,7 @@ const LookupJobSchemaDefinition = z.object({
9
9
  createdAt: z.iso.datetime({ offset: true }),
10
10
  /** Why the job failed; absent unless state is FAILED. */
11
11
  failureReason: z.string().nullish(),
12
- /** Subject jobs only: once COMPLETED, the identification GET or POST /v1/lookup or POST /v1/entities/lookup returns for source.subject, including requested filing and source-claim outcomes; absent otherwise. */
12
+ /** Subject jobs only: once COMPLETED, the identification returned for source.subject by POST /v1/lookup (kind in the JSON body), including requested filing and source-claim outcomes; absent otherwise. */
13
13
  identification: IdentificationSchema.nullish(),
14
14
  /** Lookup job id. */
15
15
  jobId: z.uuid(),
@@ -7,12 +7,19 @@ declare const MediaUploadSchemaDefinition: z.ZodObject<{
7
7
  LOW: "LOW";
8
8
  MEDIUM: "MEDIUM";
9
9
  }>;
10
- method: z.ZodEnum<{
10
+ method: z.ZodUnion<readonly [z.ZodEnum<{
11
11
  OPERATOR_REVIEW: "OPERATOR_REVIEW";
12
12
  PERCEPTUAL_HASH: "PERCEPTUAL_HASH";
13
13
  REFERENCE_UNAVAILABLE: "REFERENCE_UNAVAILABLE";
14
14
  VISION: "VISION";
15
- }>;
15
+ }>, z.ZodString]> & {
16
+ enum: {
17
+ OPERATOR_REVIEW: "OPERATOR_REVIEW";
18
+ PERCEPTUAL_HASH: "PERCEPTUAL_HASH";
19
+ REFERENCE_UNAVAILABLE: "REFERENCE_UNAVAILABLE";
20
+ VISION: "VISION";
21
+ };
22
+ };
16
23
  outcome: z.ZodEnum<{
17
24
  INSUFFICIENT: "INSUFFICIENT";
18
25
  MATCH: "MATCH";
@@ -739,6 +739,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
739
739
  JsonValue: { modulePath: "http/json-value", schemaName: "JsonValueSchema" },
740
740
  LinkSearch: { modulePath: "link/search", schemaName: "LinkSearchSchema" },
741
741
  LogoAccuracy: { modulePath: "logo/accuracy", schemaName: "LogoAccuracySchema" },
742
+ LogoAccuracyMethod: {
743
+ modulePath: "logo/accuracy-method",
744
+ schemaName: "LogoAccuracyMethodSchema",
745
+ },
742
746
  LogoAccuracyReference: {
743
747
  modulePath: "logo/accuracy-reference",
744
748
  schemaName: "LogoAccuracyReferenceSchema",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.275",
3
+ "version": "0.8.277",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",