@aventurevc/api-schemas 0.8.258 → 0.8.259

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,6 +7,7 @@ declare const BillingAdditionalUsageMeterSchemaDefinition: z.ZodObject<{
7
7
  COMPANY: "COMPANY";
8
8
  ENTITY_BRAND: "ENTITY_BRAND";
9
9
  ENTITY_VIEW: "ENTITY_VIEW";
10
+ EXPORT: "EXPORT";
10
11
  PERSON: "PERSON";
11
12
  PERSON_VIEW: "PERSON_VIEW";
12
13
  WEB_SEARCH: "WEB_SEARCH";
@@ -16,6 +17,7 @@ declare const BillingAdditionalUsageMeterSchemaDefinition: z.ZodObject<{
16
17
  COMPANY: "COMPANY";
17
18
  ENTITY_BRAND: "ENTITY_BRAND";
18
19
  ENTITY_VIEW: "ENTITY_VIEW";
20
+ EXPORT: "EXPORT";
19
21
  PERSON: "PERSON";
20
22
  PERSON_VIEW: "PERSON_VIEW";
21
23
  WEB_SEARCH: "WEB_SEARCH";
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * One metered allowance a paid subscriber may use past its monthly cap.
3
+ * One metered allowance a paid subscriber may use past its included cap.
4
4
  *
5
5
  * @openapiSchema BillingAdditionalUsageType
6
6
  * @endpoint GET /v1/billing/plans
@@ -16,6 +16,7 @@ export declare const BillingAdditionalUsageTypeSchema: z.ZodUnion<readonly [z.Zo
16
16
  COMPANY: "COMPANY";
17
17
  ENTITY_BRAND: "ENTITY_BRAND";
18
18
  ENTITY_VIEW: "ENTITY_VIEW";
19
+ EXPORT: "EXPORT";
19
20
  PERSON: "PERSON";
20
21
  PERSON_VIEW: "PERSON_VIEW";
21
22
  WEB_SEARCH: "WEB_SEARCH";
@@ -25,6 +26,7 @@ export declare const BillingAdditionalUsageTypeSchema: z.ZodUnion<readonly [z.Zo
25
26
  COMPANY: "COMPANY";
26
27
  ENTITY_BRAND: "ENTITY_BRAND";
27
28
  ENTITY_VIEW: "ENTITY_VIEW";
29
+ EXPORT: "EXPORT";
28
30
  PERSON: "PERSON";
29
31
  PERSON_VIEW: "PERSON_VIEW";
30
32
  WEB_SEARCH: "WEB_SEARCH";
@@ -7,10 +7,11 @@ const BillingAdditionalUsageTypeSchemaKnownMembers = z.enum([
7
7
  "ENTITY_BRAND",
8
8
  "PERSON_VIEW",
9
9
  "WEB_SEARCH",
10
+ "EXPORT",
10
11
  "AI_CREDIT",
11
12
  ]);
12
13
  /**
13
- * One metered allowance a paid subscriber may use past its monthly cap.
14
+ * One metered allowance a paid subscriber may use past its included cap.
14
15
  *
15
16
  * @openapiSchema BillingAdditionalUsageType
16
17
  * @endpoint GET /v1/billing/plans
@@ -5,6 +5,7 @@ declare const BillingCatalogAdditionalUsageSchemaDefinition: z.ZodObject<{
5
5
  COMPANY: "COMPANY";
6
6
  ENTITY_BRAND: "ENTITY_BRAND";
7
7
  ENTITY_VIEW: "ENTITY_VIEW";
8
+ EXPORT: "EXPORT";
8
9
  PERSON: "PERSON";
9
10
  PERSON_VIEW: "PERSON_VIEW";
10
11
  WEB_SEARCH: "WEB_SEARCH";
@@ -14,6 +15,7 @@ declare const BillingCatalogAdditionalUsageSchemaDefinition: z.ZodObject<{
14
15
  COMPANY: "COMPANY";
15
16
  ENTITY_BRAND: "ENTITY_BRAND";
16
17
  ENTITY_VIEW: "ENTITY_VIEW";
18
+ EXPORT: "EXPORT";
17
19
  PERSON: "PERSON";
18
20
  PERSON_VIEW: "PERSON_VIEW";
19
21
  WEB_SEARCH: "WEB_SEARCH";
@@ -8,6 +8,11 @@ declare const FederatedSearchProvenanceSchemaDefinition: z.ZodObject<{
8
8
  modeRequested: string;
9
9
  modeUsed: string;
10
10
  }, import("../search/mode-execution.ts").SearchModeExecutionSchemaInput>>;
11
+ incompleteScope: z.ZodOptional<z.ZodArray<z.ZodEnum<{
12
+ entity: "entity";
13
+ news: "news";
14
+ person: "person";
15
+ }>>>;
11
16
  news: z.ZodType<{
12
17
  modeRequested: string;
13
18
  modeUsed: string;
@@ -7,6 +7,8 @@ const FederatedSearchProvenanceSchemaDefinition = z.object({
7
7
  answerUnavailable: z.boolean(),
8
8
  /** Entity search strategy execution. */
9
9
  entity: SearchModeExecutionSchema,
10
+ /** Scopes whose optional sources did not all complete. Returned rows remain fully judged and usable but the population is incomplete, so this response must not be cached as final. Retrying the same query may complete these scopes. */
11
+ incompleteScope: z.array(z.enum(["entity", "person", "news"])).optional(),
10
12
  /** News search strategy execution. */
11
13
  news: SearchModeExecutionSchema,
12
14
  /** Person search strategy execution. */
@@ -10210,6 +10210,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
10210
10210
  modeRequested: string;
10211
10211
  modeUsed: string;
10212
10212
  };
10213
+ incompleteScope?: ("entity" | "news" | "person")[] | undefined;
10213
10214
  news: {
10214
10215
  modeRequested: string;
10215
10216
  modeUsed: string;
@@ -10230,6 +10231,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
10230
10231
  modeRequested: string;
10231
10232
  modeUsed: string;
10232
10233
  };
10234
+ incompleteScope?: ("entity" | "news" | "person")[] | undefined;
10233
10235
  news: {
10234
10236
  modeRequested: string;
10235
10237
  modeUsed: string;
@@ -31,7 +31,7 @@ export const IdentificationSubjectSchema = z.object({
31
31
  name: z.string().max(200).nullish(),
32
32
  /** 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. */
33
33
  providerId: z.uuid().nullish(),
34
- /** Permanent source identity for a catalog source-binding type. Requires private visibility and resolves before names or URLs. */
34
+ /** Permanent source identity with idType and identifier for a catalog source-binding type. Legacy source may be omitted or null; non-null labels are rejected. Requires private visibility and resolves before names or URLs. */
35
35
  sourceIdentifier: UniqueIdMutationSchema.nullish(),
36
36
  /** aVenture news id of the article that mentions the subject; an unknown id is a 400. */
37
37
  sourceNewsId: z.int().nullish(),
@@ -5155,6 +5155,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
5155
5155
  modeRequested: string;
5156
5156
  modeUsed: string;
5157
5157
  };
5158
+ incompleteScope?: ("entity" | "news" | "person")[] | undefined;
5158
5159
  news: {
5159
5160
  modeRequested: string;
5160
5161
  modeUsed: string;
@@ -10333,6 +10334,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
10333
10334
  modeRequested: string;
10334
10335
  modeUsed: string;
10335
10336
  };
10337
+ incompleteScope?: ("entity" | "news" | "person")[] | undefined;
10336
10338
  news: {
10337
10339
  modeRequested: string;
10338
10340
  modeUsed: string;
@@ -4,7 +4,7 @@ import { ProseProblemSchema } from "./problem.js";
4
4
  const ProseViolationSchemaDefinition = z.object({
5
5
  /** Whether proseOverrideReason can accept this problem; ProblemDetail.hint says when an override is allowed. */
6
6
  overridable: z.boolean(),
7
- /** The rejected sentence, the whole text for a text-contract violation, or the source URL for a legal-page source. */
7
+ /** The rejected sentence or paragraph, the whole text for a global text-contract violation, or the source URL for a legal-page source. */
8
8
  passage: z.string(),
9
9
  /** The problem this passage shows. */
10
10
  problem: ProseProblemSchema,
@@ -4,7 +4,7 @@ import { EntityResearchValueTypeSchema } from "../entity/research-value-type.js"
4
4
  import { ResearchValueRangeSchema } from "./value-range.js";
5
5
  import { ResearchValueShapeTypeSchema } from "./value-shape-type.js";
6
6
  const ResearchDetailTypeSchemaDefinition = z.object({
7
- /** Allowed valueResearchDetail tokens for enumeratedToken shapes. */
7
+ /** Allowed valueResearchDetail tokens, or textValue categories when valueShape is freeText. */
8
8
  allowedToken: z.array(z.string()).nullish(),
9
9
  curated: z.boolean(),
10
10
  label: z.string(),
@@ -1,6 +1,7 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const SearchHitSchemaDefinition: z.ZodObject<{
3
3
  image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4
+ publishedDate: z.ZodOptional<z.ZodNullable<z.ZodISODate>>;
4
5
  relevanceScore: z.ZodNumber;
5
6
  snippet: z.ZodString;
6
7
  title: z.ZodString;
@@ -3,6 +3,8 @@ import { z } from "zod/v4";
3
3
  const SearchHitSchemaDefinition = z.object({
4
4
  /** Image the provider attached to this result (a LinkedIn profile's headshot); null when it attached none. */
5
5
  image: z.string().nullish(),
6
+ /** Provider-reported source publication calendar date, retaining the date in its reported offset rather than converting to UTC. Null when no valid complete ISO publication date is supplied; never inferred from the URL or retrieval time. */
7
+ publishedDate: z.iso.date().nullish(),
6
8
  relevanceScore: z.number(),
7
9
  snippet: z.string(),
8
10
  title: z.string(),
@@ -5166,6 +5166,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
5166
5166
  modeRequested: string;
5167
5167
  modeUsed: string;
5168
5168
  };
5169
+ incompleteScope?: ("entity" | "news" | "person")[] | undefined;
5169
5170
  news: {
5170
5171
  modeRequested: string;
5171
5172
  modeUsed: string;
@@ -10344,6 +10345,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
10344
10345
  modeRequested: string;
10345
10346
  modeUsed: string;
10346
10347
  };
10348
+ incompleteScope?: ("entity" | "news" | "person")[] | undefined;
10347
10349
  news: {
10348
10350
  modeRequested: string;
10349
10351
  modeUsed: string;
@@ -81,12 +81,14 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
81
81
  relatedSearch: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
82
82
  result: z.ZodArray<z.ZodType<{
83
83
  image?: string | null | undefined;
84
+ publishedDate?: string | null | undefined;
84
85
  relevanceScore: number;
85
86
  snippet: string;
86
87
  title: string;
87
88
  url: string;
88
89
  }, import("../search/hit.ts").SearchHitSchemaInput, z.core.$ZodTypeInternals<{
89
90
  image?: string | null | undefined;
91
+ publishedDate?: string | null | undefined;
90
92
  relevanceScore: number;
91
93
  snippet: string;
92
94
  title: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.258",
3
+ "version": "0.8.259",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",