@aventurevc/api-schemas 0.8.258 → 0.8.260

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 (33) hide show
  1. package/dist/billing/additional-usage-type.d.ts +1 -1
  2. package/dist/billing/additional-usage-type.js +1 -1
  3. package/dist/billing/catalog-allowance.d.ts +0 -2
  4. package/dist/billing/catalog-plan.d.ts +0 -2
  5. package/dist/billing/catalog-plan.js +0 -4
  6. package/dist/billing/catalog.d.ts +1 -5
  7. package/dist/billing/catalog.js +1 -1
  8. package/dist/billing/subscription.d.ts +0 -14
  9. package/dist/directory/export.d.ts +13 -21
  10. package/dist/directory/export.js +1 -0
  11. package/dist/enrichment/enrichment.d.ts +0 -2
  12. package/dist/federated/search-provenance.d.ts +5 -0
  13. package/dist/federated/search-provenance.js +2 -0
  14. package/dist/federated/search.d.ts +2 -0
  15. package/dist/harness/run-detail.d.ts +0 -2
  16. package/dist/harness/run.d.ts +0 -2
  17. package/dist/http/problem-detail.d.ts +0 -2
  18. package/dist/identification/subject.js +1 -1
  19. package/dist/link/search.d.ts +2 -0
  20. package/dist/pagination/schemas.d.ts +0 -2
  21. package/dist/prose/violation.js +1 -1
  22. package/dist/research/allowance-type.d.ts +1 -3
  23. package/dist/research/allowance-type.js +1 -2
  24. package/dist/research/allowance-usage.d.ts +130 -231
  25. package/dist/research/allowance-usage.js +0 -2
  26. package/dist/research/allowance.d.ts +18 -13
  27. package/dist/research/allowance.js +14 -13
  28. package/dist/research/detail-type.js +1 -1
  29. package/dist/search/hit.d.ts +1 -0
  30. package/dist/search/hit.js +2 -0
  31. package/dist/shared/search.d.ts +2 -0
  32. package/dist/web/search.d.ts +2 -0
  33. package/package.json +1 -1
package/dist/billing/additional-usage-type.d.ts CHANGED
@@ -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
package/dist/billing/additional-usage-type.js CHANGED
@@ -10,7 +10,7 @@ const BillingAdditionalUsageTypeSchemaKnownMembers = z.enum([
10
10
  "AI_CREDIT",
11
11
  ]);
12
12
  /**
13
- * One metered allowance a paid subscriber may use past its monthly cap.
13
+ * One metered allowance a paid subscriber may use past its included cap.
14
14
  *
15
15
  * @openapiSchema BillingAdditionalUsageType
16
16
  * @endpoint GET /v1/billing/plans
package/dist/billing/catalog-allowance.d.ts CHANGED
@@ -5,7 +5,6 @@ declare const BillingCatalogAllowanceSchemaDefinition: z.ZodObject<{
5
5
  COMPANY: "COMPANY";
6
6
  ENTITY_BRAND: "ENTITY_BRAND";
7
7
  ENTITY_VIEW: "ENTITY_VIEW";
8
- EXPORT: "EXPORT";
9
8
  PERSON: "PERSON";
10
9
  PERSON_VIEW: "PERSON_VIEW";
11
10
  WEB_SEARCH: "WEB_SEARCH";
@@ -14,7 +13,6 @@ declare const BillingCatalogAllowanceSchemaDefinition: z.ZodObject<{
14
13
  COMPANY: "COMPANY";
15
14
  ENTITY_BRAND: "ENTITY_BRAND";
16
15
  ENTITY_VIEW: "ENTITY_VIEW";
17
- EXPORT: "EXPORT";
18
16
  PERSON: "PERSON";
19
17
  PERSON_VIEW: "PERSON_VIEW";
20
18
  WEB_SEARCH: "WEB_SEARCH";
package/dist/billing/catalog-plan.d.ts CHANGED
@@ -4,8 +4,6 @@ declare const BillingCatalogPlanSchemaDefinition: z.ZodObject<{
4
4
  cadence: z.ZodString;
5
5
  currency: z.ZodString;
6
6
  displayName: z.ZodString;
7
- exportLimit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
8
- exportPeriod: z.ZodOptional<z.ZodString>;
9
7
  introductoryAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
10
8
  plan: z.ZodUnion<readonly [z.ZodEnum<{
11
9
  PLUS_MONTHLY: "PLUS_MONTHLY";
package/dist/billing/catalog-plan.js CHANGED
@@ -9,10 +9,6 @@ const BillingCatalogPlanSchemaDefinition = z.object({
9
9
  /** ISO 4217 currency code. */
10
10
  currency: z.string(),
11
11
  displayName: z.string(),
12
- /** Distinct exported records per exportPeriod; absent means uncapped. */
13
- exportLimit: z.int().nullish(),
14
- /** ISO 8601 export allowance period: P1M is a UTC month; P1Y is the subscription billing period, available in full at its start. */
15
- exportPeriod: z.string().optional(),
16
12
  /** First invoice amount in currency minor units (USD cents) when an automatic, one-time Checkout offer is available; absent otherwise. Renewals use unitAmount. */
17
13
  introductoryAmount: z.number().int().nullish(),
18
14
  plan: BillingPlanTypeSchema,
package/dist/billing/catalog.d.ts CHANGED
@@ -20,8 +20,6 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
20
20
  cadence: string;
21
21
  currency: string;
22
22
  displayName: string;
23
- exportLimit?: number | null | undefined;
24
- exportPeriod?: string | undefined;
25
23
  introductoryAmount?: number | null | undefined;
26
24
  plan: string;
27
25
  tier: "ESSENTIAL" | "PLUS" | "PRO" | "UNLIMITED";
@@ -31,8 +29,6 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
31
29
  cadence: string;
32
30
  currency: string;
33
31
  displayName: string;
34
- exportLimit?: number | null | undefined;
35
- exportPeriod?: string | undefined;
36
32
  introductoryAmount?: number | null | undefined;
37
33
  plan: string;
38
34
  tier: "ESSENTIAL" | "PLUS" | "PRO" | "UNLIMITED";
@@ -66,7 +62,7 @@ type BillingCatalogDefinition = z.infer<typeof BillingCatalogSchemaDefinition>;
66
62
  export interface BillingCatalogSchemaInput extends z.input<typeof BillingCatalogSchemaDefinition> {
67
63
  }
68
64
  /**
69
- * Every self-serve subscription tier with its monthly allowance caps and free daily allowances, every plan Checkout sells with its effective export cap and period, and the prices of eligible usage past those caps. The Unlimited tier is not sold through Checkout and is omitted.
65
+ * Every self-serve subscription tier with its monthly allowance caps and free daily allowances, every plan Checkout sells, and the prices of eligible usage past those caps. The Unlimited tier is not sold through Checkout and is omitted.
70
66
  *
71
67
  * @openapiSchema BillingCatalog
72
68
  * @endpoint GET /v1/billing/plans
package/dist/billing/catalog.js CHANGED
@@ -13,7 +13,7 @@ const BillingCatalogSchemaDefinition = z.object({
13
13
  tier: z.array(BillingCatalogTierSchema),
14
14
  });
15
15
  /**
16
- * Every self-serve subscription tier with its monthly allowance caps and free daily allowances, every plan Checkout sells with its effective export cap and period, and the prices of eligible usage past those caps. The Unlimited tier is not sold through Checkout and is omitted.
16
+ * Every self-serve subscription tier with its monthly allowance caps and free daily allowances, every plan Checkout sells, and the prices of eligible usage past those caps. The Unlimited tier is not sold through Checkout and is omitted.
17
17
  *
18
18
  * @openapiSchema BillingCatalog
19
19
  * @endpoint GET /v1/billing/plans
package/dist/billing/subscription.d.ts CHANGED
@@ -53,13 +53,6 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
53
53
  resetAt: string;
54
54
  used: number;
55
55
  };
56
- export?: {
57
- access?: string | null | undefined;
58
- limit?: number | null | undefined;
59
- remaining?: number | null | undefined;
60
- resetAt: string;
61
- used: number;
62
- } | undefined;
63
56
  newCompany: {
64
57
  access?: string | null | undefined;
65
58
  limit?: number | null | undefined;
@@ -131,13 +124,6 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
131
124
  resetAt: string;
132
125
  used: number;
133
126
  };
134
- export?: {
135
- access?: string | null | undefined;
136
- limit?: number | null | undefined;
137
- remaining?: number | null | undefined;
138
- resetAt: string;
139
- used: number;
140
- } | undefined;
141
127
  newCompany: {
142
128
  access?: string | null | undefined;
143
129
  limit?: number | null | undefined;
package/dist/directory/export.d.ts CHANGED
@@ -1,26 +1,18 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const DirectoryExportSchemaDefinition: z.ZodObject<{
3
- allowance: z.ZodObject<{
4
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
5
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
6
- BILLING_BLOCKED: "BILLING_BLOCKED";
7
- EXHAUSTED: "EXHAUSTED";
8
- INCLUDED: "INCLUDED";
9
- PLAN_REQUIRED: "PLAN_REQUIRED";
10
- }>, z.ZodString]> & {
11
- enum: {
12
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
13
- BILLING_BLOCKED: "BILLING_BLOCKED";
14
- EXHAUSTED: "EXHAUSTED";
15
- INCLUDED: "INCLUDED";
16
- PLAN_REQUIRED: "PLAN_REQUIRED";
17
- };
18
- }>>;
19
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
20
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
21
- resetAt: z.ZodISODateTime;
22
- used: z.ZodInt;
23
- }, z.core.$strip>;
3
+ allowance: z.ZodType<{
4
+ access?: string | null | undefined;
5
+ limit?: number | null | undefined;
6
+ remaining?: number | null | undefined;
7
+ resetAt: string;
8
+ used: number;
9
+ }, import("../research/allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
10
+ access?: string | null | undefined;
11
+ limit?: number | null | undefined;
12
+ remaining?: number | null | undefined;
13
+ resetAt: string;
14
+ used: number;
15
+ }, import("../research/allowance.ts").ResearchAllowanceSchemaInput>>;
24
16
  column: z.ZodArray<z.ZodString>;
25
17
  directory: z.ZodEnum<{
26
18
  companies: "companies";
package/dist/directory/export.js CHANGED
@@ -3,6 +3,7 @@ import { z } from "zod/v4";
3
3
  import { ResearchAllowanceSchema } from "../research/allowance.js";
4
4
  import { SharedDirectoryTypeSchema } from "../shared/directory-type.js";
5
5
  const DirectoryExportSchemaDefinition = z.object({
6
+ /** The shared monthly entityView allowance for company or investor rows, or personView allowance for person rows, after this export. */
6
7
  allowance: ResearchAllowanceSchema,
7
8
  column: z.array(z.string()),
8
9
  directory: SharedDirectoryTypeSchema,
package/dist/enrichment/enrichment.d.ts CHANGED
@@ -66,7 +66,6 @@ declare const EnrichmentSchemaDefinition: z.ZodObject<{
66
66
  COMPANY: "COMPANY";
67
67
  ENTITY_BRAND: "ENTITY_BRAND";
68
68
  ENTITY_VIEW: "ENTITY_VIEW";
69
- EXPORT: "EXPORT";
70
69
  PERSON: "PERSON";
71
70
  PERSON_VIEW: "PERSON_VIEW";
72
71
  WEB_SEARCH: "WEB_SEARCH";
@@ -75,7 +74,6 @@ declare const EnrichmentSchemaDefinition: z.ZodObject<{
75
74
  COMPANY: "COMPANY";
76
75
  ENTITY_BRAND: "ENTITY_BRAND";
77
76
  ENTITY_VIEW: "ENTITY_VIEW";
78
- EXPORT: "EXPORT";
79
77
  PERSON: "PERSON";
80
78
  PERSON_VIEW: "PERSON_VIEW";
81
79
  WEB_SEARCH: "WEB_SEARCH";
package/dist/federated/search-provenance.d.ts CHANGED
@@ -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;
package/dist/federated/search-provenance.js CHANGED
@@ -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. */
package/dist/federated/search.d.ts CHANGED
@@ -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;
package/dist/harness/run-detail.d.ts CHANGED
@@ -167,7 +167,6 @@ declare const HarnessRunDetailSchemaDefinition: z.ZodObject<{
167
167
  COMPANY: "COMPANY";
168
168
  ENTITY_BRAND: "ENTITY_BRAND";
169
169
  ENTITY_VIEW: "ENTITY_VIEW";
170
- EXPORT: "EXPORT";
171
170
  PERSON: "PERSON";
172
171
  PERSON_VIEW: "PERSON_VIEW";
173
172
  WEB_SEARCH: "WEB_SEARCH";
@@ -176,7 +175,6 @@ declare const HarnessRunDetailSchemaDefinition: z.ZodObject<{
176
175
  COMPANY: "COMPANY";
177
176
  ENTITY_BRAND: "ENTITY_BRAND";
178
177
  ENTITY_VIEW: "ENTITY_VIEW";
179
- EXPORT: "EXPORT";
180
178
  PERSON: "PERSON";
181
179
  PERSON_VIEW: "PERSON_VIEW";
182
180
  WEB_SEARCH: "WEB_SEARCH";
package/dist/harness/run.d.ts CHANGED
@@ -64,7 +64,6 @@ export declare const HarnessRunSchema: z.ZodObject<{
64
64
  COMPANY: "COMPANY";
65
65
  ENTITY_BRAND: "ENTITY_BRAND";
66
66
  ENTITY_VIEW: "ENTITY_VIEW";
67
- EXPORT: "EXPORT";
68
67
  PERSON: "PERSON";
69
68
  PERSON_VIEW: "PERSON_VIEW";
70
69
  WEB_SEARCH: "WEB_SEARCH";
@@ -73,7 +72,6 @@ export declare const HarnessRunSchema: z.ZodObject<{
73
72
  COMPANY: "COMPANY";
74
73
  ENTITY_BRAND: "ENTITY_BRAND";
75
74
  ENTITY_VIEW: "ENTITY_VIEW";
76
- EXPORT: "EXPORT";
77
75
  PERSON: "PERSON";
78
76
  PERSON_VIEW: "PERSON_VIEW";
79
77
  WEB_SEARCH: "WEB_SEARCH";
package/dist/http/problem-detail.d.ts CHANGED
@@ -4,7 +4,6 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
4
4
  COMPANY: "COMPANY";
5
5
  ENTITY_BRAND: "ENTITY_BRAND";
6
6
  ENTITY_VIEW: "ENTITY_VIEW";
7
- EXPORT: "EXPORT";
8
7
  PERSON: "PERSON";
9
8
  PERSON_VIEW: "PERSON_VIEW";
10
9
  WEB_SEARCH: "WEB_SEARCH";
@@ -13,7 +12,6 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
13
12
  COMPANY: "COMPANY";
14
13
  ENTITY_BRAND: "ENTITY_BRAND";
15
14
  ENTITY_VIEW: "ENTITY_VIEW";
16
- EXPORT: "EXPORT";
17
15
  PERSON: "PERSON";
18
16
  PERSON_VIEW: "PERSON_VIEW";
19
17
  WEB_SEARCH: "WEB_SEARCH";
package/dist/identification/subject.js CHANGED
@@ -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(),
package/dist/link/search.d.ts CHANGED
@@ -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;
package/dist/pagination/schemas.d.ts CHANGED
@@ -10148,7 +10148,6 @@ declare const PageHarnessRunSchemaDefinition: z.ZodObject<{
10148
10148
  COMPANY: "COMPANY";
10149
10149
  ENTITY_BRAND: "ENTITY_BRAND";
10150
10150
  ENTITY_VIEW: "ENTITY_VIEW";
10151
- EXPORT: "EXPORT";
10152
10151
  PERSON: "PERSON";
10153
10152
  PERSON_VIEW: "PERSON_VIEW";
10154
10153
  WEB_SEARCH: "WEB_SEARCH";
@@ -10157,7 +10156,6 @@ declare const PageHarnessRunSchemaDefinition: z.ZodObject<{
10157
10156
  COMPANY: "COMPANY";
10158
10157
  ENTITY_BRAND: "ENTITY_BRAND";
10159
10158
  ENTITY_VIEW: "ENTITY_VIEW";
10160
- EXPORT: "EXPORT";
10161
10159
  PERSON: "PERSON";
10162
10160
  PERSON_VIEW: "PERSON_VIEW";
10163
10161
  WEB_SEARCH: "WEB_SEARCH";
package/dist/prose/violation.js CHANGED
@@ -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,
package/dist/research/allowance-type.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Metered allowance. `COMPANY` and `PERSON` meter research runs on company and person-profile targets; `ENTITY_VIEW`, `ENTITY_BRAND`, and `PERSON_VIEW` meter profile and brand reads; `WEB_SEARCH` meters web searches; `EXPORT` meters distinct exported records.
3
+ * Metered allowance. `COMPANY` and `PERSON` meter research runs on company and person-profile targets; `ENTITY_VIEW`, `ENTITY_BRAND`, and `PERSON_VIEW` meter profile and brand reads. Directory exports share `ENTITY_VIEW` for company and investor rows and `PERSON_VIEW` for person rows, once per record per UTC month with detail views; `WEB_SEARCH` meters web searches.
4
4
  *
5
5
  * @openapiSchema ResearchAllowanceType
6
6
  * @standardProblemResponse
@@ -14,7 +14,6 @@ export declare const ResearchAllowanceTypeSchema: z.ZodUnion<readonly [z.ZodEnum
14
14
  COMPANY: "COMPANY";
15
15
  ENTITY_BRAND: "ENTITY_BRAND";
16
16
  ENTITY_VIEW: "ENTITY_VIEW";
17
- EXPORT: "EXPORT";
18
17
  PERSON: "PERSON";
19
18
  PERSON_VIEW: "PERSON_VIEW";
20
19
  WEB_SEARCH: "WEB_SEARCH";
@@ -23,7 +22,6 @@ export declare const ResearchAllowanceTypeSchema: z.ZodUnion<readonly [z.ZodEnum
23
22
  COMPANY: "COMPANY";
24
23
  ENTITY_BRAND: "ENTITY_BRAND";
25
24
  ENTITY_VIEW: "ENTITY_VIEW";
26
- EXPORT: "EXPORT";
27
25
  PERSON: "PERSON";
28
26
  PERSON_VIEW: "PERSON_VIEW";
29
27
  WEB_SEARCH: "WEB_SEARCH";
package/dist/research/allowance-type.js CHANGED
@@ -7,10 +7,9 @@ const ResearchAllowanceTypeSchemaKnownMembers = z.enum([
7
7
  "ENTITY_BRAND",
8
8
  "PERSON_VIEW",
9
9
  "WEB_SEARCH",
10
- "EXPORT",
11
10
  ]);
12
11
  /**
13
- * Metered allowance. `COMPANY` and `PERSON` meter research runs on company and person-profile targets; `ENTITY_VIEW`, `ENTITY_BRAND`, and `PERSON_VIEW` meter profile and brand reads; `WEB_SEARCH` meters web searches; `EXPORT` meters distinct exported records.
12
+ * Metered allowance. `COMPANY` and `PERSON` meter research runs on company and person-profile targets; `ENTITY_VIEW`, `ENTITY_BRAND`, and `PERSON_VIEW` meter profile and brand reads. Directory exports share `ENTITY_VIEW` for company and investor rows and `PERSON_VIEW` for person rows, once per record per UTC month with detail views; `WEB_SEARCH` meters web searches.
14
13
  *
15
14
  * @openapiSchema ResearchAllowanceType
16
15
  * @standardProblemResponse
package/dist/research/allowance-usage.d.ts CHANGED
@@ -1,236 +1,135 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const ResearchAllowanceUsageSchemaDefinition: z.ZodObject<{
3
- company: z.ZodObject<{
4
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
5
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
6
- BILLING_BLOCKED: "BILLING_BLOCKED";
7
- EXHAUSTED: "EXHAUSTED";
8
- INCLUDED: "INCLUDED";
9
- PLAN_REQUIRED: "PLAN_REQUIRED";
10
- }>, z.ZodString]> & {
11
- enum: {
12
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
13
- BILLING_BLOCKED: "BILLING_BLOCKED";
14
- EXHAUSTED: "EXHAUSTED";
15
- INCLUDED: "INCLUDED";
16
- PLAN_REQUIRED: "PLAN_REQUIRED";
17
- };
18
- }>>;
19
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
20
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
21
- resetAt: z.ZodISODateTime;
22
- used: z.ZodInt;
23
- }, z.core.$strip>;
24
- entityBrand: z.ZodObject<{
25
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
26
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
27
- BILLING_BLOCKED: "BILLING_BLOCKED";
28
- EXHAUSTED: "EXHAUSTED";
29
- INCLUDED: "INCLUDED";
30
- PLAN_REQUIRED: "PLAN_REQUIRED";
31
- }>, z.ZodString]> & {
32
- enum: {
33
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
34
- BILLING_BLOCKED: "BILLING_BLOCKED";
35
- EXHAUSTED: "EXHAUSTED";
36
- INCLUDED: "INCLUDED";
37
- PLAN_REQUIRED: "PLAN_REQUIRED";
38
- };
39
- }>>;
40
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
41
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
42
- resetAt: z.ZodISODateTime;
43
- used: z.ZodInt;
44
- }, z.core.$strip>;
45
- entityView: z.ZodObject<{
46
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
47
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
48
- BILLING_BLOCKED: "BILLING_BLOCKED";
49
- EXHAUSTED: "EXHAUSTED";
50
- INCLUDED: "INCLUDED";
51
- PLAN_REQUIRED: "PLAN_REQUIRED";
52
- }>, z.ZodString]> & {
53
- enum: {
54
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
55
- BILLING_BLOCKED: "BILLING_BLOCKED";
56
- EXHAUSTED: "EXHAUSTED";
57
- INCLUDED: "INCLUDED";
58
- PLAN_REQUIRED: "PLAN_REQUIRED";
59
- };
60
- }>>;
61
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
62
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
63
- resetAt: z.ZodISODateTime;
64
- used: z.ZodInt;
65
- }, z.core.$strip>;
66
- export: z.ZodOptional<z.ZodObject<{
67
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
68
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
69
- BILLING_BLOCKED: "BILLING_BLOCKED";
70
- EXHAUSTED: "EXHAUSTED";
71
- INCLUDED: "INCLUDED";
72
- PLAN_REQUIRED: "PLAN_REQUIRED";
73
- }>, z.ZodString]> & {
74
- enum: {
75
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
76
- BILLING_BLOCKED: "BILLING_BLOCKED";
77
- EXHAUSTED: "EXHAUSTED";
78
- INCLUDED: "INCLUDED";
79
- PLAN_REQUIRED: "PLAN_REQUIRED";
80
- };
81
- }>>;
82
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
83
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
84
- resetAt: z.ZodISODateTime;
85
- used: z.ZodInt;
86
- }, z.core.$strip>>;
87
- newCompany: z.ZodObject<{
88
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
89
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
90
- BILLING_BLOCKED: "BILLING_BLOCKED";
91
- EXHAUSTED: "EXHAUSTED";
92
- INCLUDED: "INCLUDED";
93
- PLAN_REQUIRED: "PLAN_REQUIRED";
94
- }>, z.ZodString]> & {
95
- enum: {
96
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
97
- BILLING_BLOCKED: "BILLING_BLOCKED";
98
- EXHAUSTED: "EXHAUSTED";
99
- INCLUDED: "INCLUDED";
100
- PLAN_REQUIRED: "PLAN_REQUIRED";
101
- };
102
- }>>;
103
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
104
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
105
- resetAt: z.ZodISODateTime;
106
- used: z.ZodInt;
107
- }, z.core.$strip>;
108
- newPerson: z.ZodObject<{
109
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
110
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
111
- BILLING_BLOCKED: "BILLING_BLOCKED";
112
- EXHAUSTED: "EXHAUSTED";
113
- INCLUDED: "INCLUDED";
114
- PLAN_REQUIRED: "PLAN_REQUIRED";
115
- }>, z.ZodString]> & {
116
- enum: {
117
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
118
- BILLING_BLOCKED: "BILLING_BLOCKED";
119
- EXHAUSTED: "EXHAUSTED";
120
- INCLUDED: "INCLUDED";
121
- PLAN_REQUIRED: "PLAN_REQUIRED";
122
- };
123
- }>>;
124
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
125
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
126
- resetAt: z.ZodISODateTime;
127
- used: z.ZodInt;
128
- }, z.core.$strip>;
129
- person: z.ZodObject<{
130
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
131
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
132
- BILLING_BLOCKED: "BILLING_BLOCKED";
133
- EXHAUSTED: "EXHAUSTED";
134
- INCLUDED: "INCLUDED";
135
- PLAN_REQUIRED: "PLAN_REQUIRED";
136
- }>, z.ZodString]> & {
137
- enum: {
138
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
139
- BILLING_BLOCKED: "BILLING_BLOCKED";
140
- EXHAUSTED: "EXHAUSTED";
141
- INCLUDED: "INCLUDED";
142
- PLAN_REQUIRED: "PLAN_REQUIRED";
143
- };
144
- }>>;
145
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
146
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
147
- resetAt: z.ZodISODateTime;
148
- used: z.ZodInt;
149
- }, z.core.$strip>;
150
- personView: z.ZodObject<{
151
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
152
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
153
- BILLING_BLOCKED: "BILLING_BLOCKED";
154
- EXHAUSTED: "EXHAUSTED";
155
- INCLUDED: "INCLUDED";
156
- PLAN_REQUIRED: "PLAN_REQUIRED";
157
- }>, z.ZodString]> & {
158
- enum: {
159
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
160
- BILLING_BLOCKED: "BILLING_BLOCKED";
161
- EXHAUSTED: "EXHAUSTED";
162
- INCLUDED: "INCLUDED";
163
- PLAN_REQUIRED: "PLAN_REQUIRED";
164
- };
165
- }>>;
166
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
167
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
168
- resetAt: z.ZodISODateTime;
169
- used: z.ZodInt;
170
- }, z.core.$strip>;
171
- update: z.ZodObject<{
172
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
173
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
174
- BILLING_BLOCKED: "BILLING_BLOCKED";
175
- EXHAUSTED: "EXHAUSTED";
176
- INCLUDED: "INCLUDED";
177
- PLAN_REQUIRED: "PLAN_REQUIRED";
178
- }>, z.ZodString]> & {
179
- enum: {
180
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
181
- BILLING_BLOCKED: "BILLING_BLOCKED";
182
- EXHAUSTED: "EXHAUSTED";
183
- INCLUDED: "INCLUDED";
184
- PLAN_REQUIRED: "PLAN_REQUIRED";
185
- };
186
- }>>;
187
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
188
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
189
- resetAt: z.ZodISODateTime;
190
- used: z.ZodInt;
191
- }, z.core.$strip>;
192
- updatePerson: z.ZodObject<{
193
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
194
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
195
- BILLING_BLOCKED: "BILLING_BLOCKED";
196
- EXHAUSTED: "EXHAUSTED";
197
- INCLUDED: "INCLUDED";
198
- PLAN_REQUIRED: "PLAN_REQUIRED";
199
- }>, z.ZodString]> & {
200
- enum: {
201
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
202
- BILLING_BLOCKED: "BILLING_BLOCKED";
203
- EXHAUSTED: "EXHAUSTED";
204
- INCLUDED: "INCLUDED";
205
- PLAN_REQUIRED: "PLAN_REQUIRED";
206
- };
207
- }>>;
208
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
209
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
210
- resetAt: z.ZodISODateTime;
211
- used: z.ZodInt;
212
- }, z.core.$strip>;
213
- webSearch: z.ZodObject<{
214
- access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
215
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
216
- BILLING_BLOCKED: "BILLING_BLOCKED";
217
- EXHAUSTED: "EXHAUSTED";
218
- INCLUDED: "INCLUDED";
219
- PLAN_REQUIRED: "PLAN_REQUIRED";
220
- }>, z.ZodString]> & {
221
- enum: {
222
- ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
223
- BILLING_BLOCKED: "BILLING_BLOCKED";
224
- EXHAUSTED: "EXHAUSTED";
225
- INCLUDED: "INCLUDED";
226
- PLAN_REQUIRED: "PLAN_REQUIRED";
227
- };
228
- }>>;
229
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
230
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
231
- resetAt: z.ZodISODateTime;
232
- used: z.ZodInt;
233
- }, z.core.$strip>;
3
+ company: z.ZodType<{
4
+ access?: string | null | undefined;
5
+ limit?: number | null | undefined;
6
+ remaining?: number | null | undefined;
7
+ resetAt: string;
8
+ used: number;
9
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
10
+ access?: string | null | undefined;
11
+ limit?: number | null | undefined;
12
+ remaining?: number | null | undefined;
13
+ resetAt: string;
14
+ used: number;
15
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
16
+ entityBrand: z.ZodType<{
17
+ access?: string | null | undefined;
18
+ limit?: number | null | undefined;
19
+ remaining?: number | null | undefined;
20
+ resetAt: string;
21
+ used: number;
22
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
23
+ access?: string | null | undefined;
24
+ limit?: number | null | undefined;
25
+ remaining?: number | null | undefined;
26
+ resetAt: string;
27
+ used: number;
28
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
29
+ entityView: z.ZodType<{
30
+ access?: string | null | undefined;
31
+ limit?: number | null | undefined;
32
+ remaining?: number | null | undefined;
33
+ resetAt: string;
34
+ used: number;
35
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
36
+ access?: string | null | undefined;
37
+ limit?: number | null | undefined;
38
+ remaining?: number | null | undefined;
39
+ resetAt: string;
40
+ used: number;
41
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
42
+ newCompany: z.ZodType<{
43
+ access?: string | null | undefined;
44
+ limit?: number | null | undefined;
45
+ remaining?: number | null | undefined;
46
+ resetAt: string;
47
+ used: number;
48
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
49
+ access?: string | null | undefined;
50
+ limit?: number | null | undefined;
51
+ remaining?: number | null | undefined;
52
+ resetAt: string;
53
+ used: number;
54
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
55
+ newPerson: z.ZodType<{
56
+ access?: string | null | undefined;
57
+ limit?: number | null | undefined;
58
+ remaining?: number | null | undefined;
59
+ resetAt: string;
60
+ used: number;
61
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
62
+ access?: string | null | undefined;
63
+ limit?: number | null | undefined;
64
+ remaining?: number | null | undefined;
65
+ resetAt: string;
66
+ used: number;
67
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
68
+ person: z.ZodType<{
69
+ access?: string | null | undefined;
70
+ limit?: number | null | undefined;
71
+ remaining?: number | null | undefined;
72
+ resetAt: string;
73
+ used: number;
74
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
75
+ access?: string | null | undefined;
76
+ limit?: number | null | undefined;
77
+ remaining?: number | null | undefined;
78
+ resetAt: string;
79
+ used: number;
80
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
81
+ personView: z.ZodType<{
82
+ access?: string | null | undefined;
83
+ limit?: number | null | undefined;
84
+ remaining?: number | null | undefined;
85
+ resetAt: string;
86
+ used: number;
87
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
88
+ access?: string | null | undefined;
89
+ limit?: number | null | undefined;
90
+ remaining?: number | null | undefined;
91
+ resetAt: string;
92
+ used: number;
93
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
94
+ update: z.ZodType<{
95
+ access?: string | null | undefined;
96
+ limit?: number | null | undefined;
97
+ remaining?: number | null | undefined;
98
+ resetAt: string;
99
+ used: number;
100
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
101
+ access?: string | null | undefined;
102
+ limit?: number | null | undefined;
103
+ remaining?: number | null | undefined;
104
+ resetAt: string;
105
+ used: number;
106
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
107
+ updatePerson: z.ZodType<{
108
+ access?: string | null | undefined;
109
+ limit?: number | null | undefined;
110
+ remaining?: number | null | undefined;
111
+ resetAt: string;
112
+ used: number;
113
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
114
+ access?: string | null | undefined;
115
+ limit?: number | null | undefined;
116
+ remaining?: number | null | undefined;
117
+ resetAt: string;
118
+ used: number;
119
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
120
+ webSearch: z.ZodType<{
121
+ access?: string | null | undefined;
122
+ limit?: number | null | undefined;
123
+ remaining?: number | null | undefined;
124
+ resetAt: string;
125
+ used: number;
126
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput, z.core.$ZodTypeInternals<{
127
+ access?: string | null | undefined;
128
+ limit?: number | null | undefined;
129
+ remaining?: number | null | undefined;
130
+ resetAt: string;
131
+ used: number;
132
+ }, import("./allowance.ts").ResearchAllowanceSchemaInput>>;
234
133
  }, z.core.$strip>;
235
134
  type ResearchAllowanceUsageDefinition = z.infer<typeof ResearchAllowanceUsageSchemaDefinition>;
236
135
  export interface ResearchAllowanceUsageSchemaInput extends z.input<typeof ResearchAllowanceUsageSchemaDefinition> {
package/dist/research/allowance-usage.js CHANGED
@@ -7,8 +7,6 @@ const ResearchAllowanceUsageSchemaDefinition = z.object({
7
7
  /** Thin company brand reads (names, logos, links, tags) */
8
8
  entityBrand: ResearchAllowanceSchema,
9
9
  entityView: ResearchAllowanceSchema,
10
- /** Distinct exported records; UTC month on monthly plans, full subscription period on yearly plans */
11
- export: ResearchAllowanceSchema.optional(),
12
10
  /** Deprecated: replaced by company, which it mirrors. */
13
11
  newCompany: ResearchAllowanceSchema,
14
12
  /** Deprecated: replaced by person, which it mirrors. */
package/dist/research/allowance.d.ts CHANGED
@@ -1,17 +1,5 @@
1
1
  import { z } from "zod/v4";
2
- /**
3
- * Usage allowance for one meter in one billing period, the UTC month by default
4
- *
5
- * @openapiSchema ResearchAllowance
6
- * @endpoint GET /v1/billing/ai-credits
7
- * @endpoint GET /v1/billing/subscription
8
- * @endpoint POST /v1/directory/exports
9
- * @usedBySchema DirectoryExportSchema
10
- * @usedBySchema ResearchAllowanceUsageSchema
11
- * @contractShape research.allowance
12
- * @contractRole canonical
13
- */
14
- export declare const ResearchAllowanceSchema: z.ZodObject<{
2
+ declare const ResearchAllowanceSchemaDefinition: z.ZodObject<{
15
3
  access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
16
4
  ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
17
5
  BILLING_BLOCKED: "BILLING_BLOCKED";
@@ -32,5 +20,22 @@ export declare const ResearchAllowanceSchema: z.ZodObject<{
32
20
  resetAt: z.ZodISODateTime;
33
21
  used: z.ZodInt;
34
22
  }, z.core.$strip>;
23
+ type ResearchAllowanceDefinition = z.infer<typeof ResearchAllowanceSchemaDefinition>;
24
+ export interface ResearchAllowanceSchemaInput extends z.input<typeof ResearchAllowanceSchemaDefinition> {
25
+ }
26
+ /**
27
+ * Usage allowance for one meter in its accounting period
28
+ *
29
+ * @openapiSchema ResearchAllowance
30
+ * @endpoint GET /v1/billing/ai-credits
31
+ * @endpoint GET /v1/billing/subscription
32
+ * @endpoint POST /v1/directory/exports
33
+ * @usedBySchema DirectoryExportSchema
34
+ * @usedBySchema ResearchAllowanceUsageSchema
35
+ * @contractShape research.allowance
36
+ * @contractRole canonical
37
+ */
38
+ export declare const ResearchAllowanceSchema: z.ZodType<ResearchAllowanceDefinition, ResearchAllowanceSchemaInput>;
35
39
  export type ResearchAllowance = z.infer<typeof ResearchAllowanceSchema>;
40
+ export {};
36
41
  //# sourceMappingURL=allowance.d.ts.map
package/dist/research/allowance.js CHANGED
@@ -1,19 +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 { ResearchAccessTypeSchema } from "./access-type.js";
4
- /**
5
- * Usage allowance for one meter in one billing period, the UTC month by default
6
- *
7
- * @openapiSchema ResearchAllowance
8
- * @endpoint GET /v1/billing/ai-credits
9
- * @endpoint GET /v1/billing/subscription
10
- * @endpoint POST /v1/directory/exports
11
- * @usedBySchema DirectoryExportSchema
12
- * @usedBySchema ResearchAllowanceUsageSchema
13
- * @contractShape research.allowance
14
- * @contractRole canonical
15
- */
16
- export const ResearchAllowanceSchema = z.object({
4
+ const ResearchAllowanceSchemaDefinition = z.object({
17
5
  /** What filing one more research run on this meter does now, decided exactly as filing decides it; present only on the company and person research meters */
18
6
  access: ResearchAccessTypeSchema.nullish(),
19
7
  /** Cap for the period; absent when the tier meters without a cap */
@@ -25,4 +13,17 @@ export const ResearchAllowanceSchema = z.object({
25
13
  /** Amount used so far in the period */
26
14
  used: z.int(),
27
15
  });
16
+ /**
17
+ * Usage allowance for one meter in its accounting period
18
+ *
19
+ * @openapiSchema ResearchAllowance
20
+ * @endpoint GET /v1/billing/ai-credits
21
+ * @endpoint GET /v1/billing/subscription
22
+ * @endpoint POST /v1/directory/exports
23
+ * @usedBySchema DirectoryExportSchema
24
+ * @usedBySchema ResearchAllowanceUsageSchema
25
+ * @contractShape research.allowance
26
+ * @contractRole canonical
27
+ */
28
+ export const ResearchAllowanceSchema = ResearchAllowanceSchemaDefinition;
28
29
  //# sourceMappingURL=allowance.js.map
package/dist/research/detail-type.js CHANGED
@@ -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(),
package/dist/search/hit.d.ts CHANGED
@@ -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;
package/dist/search/hit.js CHANGED
@@ -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(),
package/dist/shared/search.d.ts CHANGED
@@ -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;
package/dist/web/search.d.ts CHANGED
@@ -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.260",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",