@aventurevc/api-schemas 0.8.50 → 0.8.52

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.
@@ -7,7 +7,7 @@ declare const EntityDetailBatchSchemaDefinition: z.ZodObject<{
7
7
  }, z.core.$strict>;
8
8
  type EntityDetailBatchDefinition = z.infer<typeof EntityDetailBatchSchemaDefinition>;
9
9
  /**
10
- * Batch request for entity detail retrieval by id, slug, or current joined URL
10
+ * Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url.
11
11
  *
12
12
  * @openapiSchema EntityDetailBatch
13
13
  * @endpoint POST /v1/entities/lookup-batch
@@ -1,17 +1,30 @@
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 EntityDetailBatchSchemaDefinition = z.strictObject({
3
+ const EntityDetailBatchSchemaDefinition = z
4
+ .strictObject({
4
5
  /** Entity UUID values */
5
- entityId: z.array(z.uuid()).optional(),
6
+ entityId: z.array(z.uuid()).max(200).optional(),
6
7
  /** Permit monogram fallbacks */
7
8
  permitMonogram: z.boolean().nullable().default(true).optional(),
8
9
  /** Entity slug values */
9
- slug: z.array(z.string()).optional(),
10
+ slug: z.array(z.string()).max(200).optional(),
10
11
  /** Current joined entity URL values */
11
- url: z.array(z.string()).optional(),
12
+ url: z.array(z.string()).max(200).optional(),
13
+ })
14
+ .check(({ value, issues }) => {
15
+ if ((value.entityId?.length ?? 0) + (value.slug?.length ?? 0) + (value.url?.length ?? 0) >
16
+ 200) {
17
+ issues.push({
18
+ code: "custom",
19
+ origin: "custom",
20
+ path: [],
21
+ input: value,
22
+ message: "combined array item count must be at most 200",
23
+ });
24
+ }
12
25
  });
13
26
  /**
14
- * Batch request for entity detail retrieval by id, slug, or current joined URL
27
+ * Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url.
15
28
  *
16
29
  * @openapiSchema EntityDetailBatch
17
30
  * @endpoint POST /v1/entities/lookup-batch
@@ -11,6 +11,7 @@
11
11
  */
12
12
  export declare const HTTP_OK: 200;
13
13
  export declare const HTTP_CREATED: 201;
14
+ export declare const HTTP_ACCEPTED: 202;
14
15
  export declare const HTTP_NO_CONTENT: 204;
15
16
  export declare const HTTP_MOVED_PERMANENTLY: 301;
16
17
  export declare const HTTP_FOUND: 302;
@@ -12,6 +12,7 @@
12
12
  */
13
13
  export const HTTP_OK = 200;
14
14
  export const HTTP_CREATED = 201;
15
+ export const HTTP_ACCEPTED = 202;
15
16
  export const HTTP_NO_CONTENT = 204;
16
17
  export const HTTP_MOVED_PERMANENTLY = 301;
17
18
  export const HTTP_FOUND = 302;
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * The company, Product, Service, or person to identify. Send the name plus every URL, location, and source you have; a website or profile URL usually settles the answer without any model call.
3
+ * The company, Product, Service, or person to identify. Send the name, a URL it owns, or both, plus every location and source you have; a website or profile URL usually settles the answer without any model call.
4
4
  *
5
5
  * @openapiSchema IdentificationSubject
6
6
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -20,7 +20,7 @@ export declare const IdentificationSubjectSchema: z.ZodObject<{
20
20
  PERSON: "PERSON";
21
21
  }>>>;
22
22
  location: z.ZodOptional<z.ZodNullable<z.ZodString>>;
23
- name: z.ZodString;
23
+ name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
24
24
  providerId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
25
25
  sourceNewsId: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
26
26
  sourceUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { EntityTypeSchema } from "../entity/type.js";
4
4
  /**
5
- * The company, Product, Service, or person to identify. Send the name plus every URL, location, and source you have; a website or profile URL usually settles the answer without any model call.
5
+ * The company, Product, Service, or person to identify. Send the name, a URL it owns, or both, plus every location and source you have; a website or profile URL usually settles the answer without any model call.
6
6
  *
7
7
  * @openapiSchema IdentificationSubject
8
8
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -22,8 +22,8 @@ export const IdentificationSubjectSchema = z.object({
22
22
  kind: z.enum(["ENTITY", "PERSON"]).nullish(),
23
23
  /** City, region, or country, such as Austin, TX. Tells namesakes apart; not proof on its own. */
24
24
  location: z.string().max(2000).nullish(),
25
- /** Name exactly as the source writes it, such as Acme AI or Jane Doe. Required even when url is sent; to read a record from only a URL (an aVenture page, website, or domain) use the exact read instead: entities lookup-exact get --url, or people lookup-exact get --url for a person. */
26
- name: z.string().max(200),
25
+ /** Name exactly as the source writes it, such as Acme AI or Jane Doe. Send name, url, or both; a name that is an absolute http(s) URL is read as url. */
26
+ name: z.string().max(200).nullish(),
27
27
  /** Provider entity id for a Product or Service lookup. Omit it when the provider is unknown. With no typeRecord, searches both Product and Service. Invalid for a company type or a person lookup. */
28
28
  providerId: z.uuid().nullish(),
29
29
  /** aVenture news id of the article that mentions the subject; an unknown id is a 400. */
@@ -32,7 +32,7 @@ export const IdentificationSubjectSchema = z.object({
32
32
  sourceUrl: z.string().max(2000).nullish(),
33
33
  /** Entity type to identify. A Product or Service never matches its provider organization, but a record stored under a neighboring type of the same family (Product or Service; Fund, Investment Firm, or Company) still matches, and a Business Line lookup sees both families. Invalid for a person lookup. */
34
34
  typeRecord: EntityTypeSchema.nullish(),
35
- /** URLs the subject owns: its website, its LinkedIn company or person profile, or a registry page. At most 10. Put articles in sourceUrl. */
35
+ /** URLs the subject owns: its website, its LinkedIn company or person profile, an aVenture page, or a registry page. At most 10. Required when name is omitted. Put articles in sourceUrl. */
36
36
  url: z.array(z.string()).max(10).optional(),
37
37
  });
38
38
  //# sourceMappingURL=subject.js.map
@@ -20,7 +20,7 @@ declare const LookupJobMutationSchemaDefinition: z.ZodObject<{
20
20
  PERSON: "PERSON";
21
21
  }>>>;
22
22
  location: z.ZodOptional<z.ZodNullable<z.ZodString>>;
23
- name: z.ZodString;
23
+ name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
24
24
  providerId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
25
25
  sourceNewsId: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
26
26
  sourceUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1428,7 +1428,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
1428
1428
  context?: string | null | undefined;
1429
1429
  kind?: "ENTITY" | "PERSON" | null | undefined;
1430
1430
  location?: string | null | undefined;
1431
- name: string;
1431
+ name?: string | null | undefined;
1432
1432
  providerId?: string | null | undefined;
1433
1433
  sourceNewsId?: number | null | undefined;
1434
1434
  sourceUrl?: string | null | undefined;
@@ -1448,7 +1448,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
1448
1448
  context?: string | null | undefined;
1449
1449
  kind?: "ENTITY" | "PERSON" | null | undefined;
1450
1450
  location?: string | null | undefined;
1451
- name: string;
1451
+ name?: string | null | undefined;
1452
1452
  providerId?: string | null | undefined;
1453
1453
  sourceNewsId?: number | null | undefined;
1454
1454
  sourceUrl?: string | null | undefined;
@@ -13,14 +13,8 @@ export declare const NewsParamSchema: z.ZodObject<{
13
13
  page: z.ZodOptional<z.ZodInt>;
14
14
  size: z.ZodOptional<z.ZodInt>;
15
15
  sort: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
16
- authorInitial: z.ZodOptional<z.ZodString>;
17
16
  category: z.ZodOptional<z.ZodString>;
18
- cursor: z.ZodOptional<z.ZodString>;
19
17
  excludeId: z.ZodOptional<z.ZodInt>;
20
- letter: z.ZodOptional<z.ZodString>;
21
- mode: z.ZodOptional<z.ZodEnum<{
22
- thin: "thin";
23
- }>>;
24
18
  "owner.entityId": z.ZodOptional<z.ZodUUID>;
25
19
  "owner.personId": z.ZodOptional<z.ZodUUID>;
26
20
  publishedAfter: z.ZodOptional<z.ZodISODate>;
@@ -12,18 +12,10 @@ export const NEWS_ENDPOINT = "/v1/news";
12
12
  * @contractRole canonical
13
13
  */
14
14
  export const NewsParamSchema = PageParamSchema.extend({
15
- /** Author initial filter. */
16
- authorInitial: z.string().optional(),
17
15
  /** News category slug to include or exclude. */
18
16
  category: z.string().optional(),
19
- /** Cursor token returned by the previous thin page. */
20
- cursor: z.string().optional(),
21
17
  /** Exclude one news article by id. */
22
18
  excludeId: z.int().optional(),
23
- /** Deprecated: use the author-initial filter. */
24
- letter: z.string().optional(),
25
- /** Response mode: thin returns cursor-paginated index rows; omit for the standard list. */
26
- mode: z.enum(["thin"]).optional(),
27
19
  /** Owning entity id; set only when personId is absent. */
28
20
  "owner.entityId": z.uuid().optional(),
29
21
  /** Owning person id; set only when entityId is absent. */
@@ -34,15 +26,5 @@ export const NewsParamSchema = PageParamSchema.extend({
34
26
  publishedBefore: z.iso.date().optional(),
35
27
  /** Full-text news search term. */
36
28
  search: z.string().optional(),
37
- }).check(({ value, issues }) => {
38
- if (value.cursor !== undefined && value.cursor !== "" && value.sort !== undefined) {
39
- issues.push({
40
- code: "custom",
41
- origin: "custom",
42
- path: ["sort"],
43
- input: value.sort,
44
- message: "sort is not supported when cursor is provided",
45
- });
46
- }
47
29
  });
48
30
  //# sourceMappingURL=param.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.50",
3
+ "version": "0.8.52",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",