@aventurevc/api-schemas 0.8.256 → 0.8.258
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/dist/billing/additional-usage-meter.d.ts +12 -2
- package/dist/billing/additional-usage-type.d.ts +12 -2
- package/dist/billing/additional-usage-type.js +10 -9
- package/dist/billing/additional-usage.d.ts +2 -2
- package/dist/billing/catalog-additional-usage.d.ts +12 -2
- package/dist/billing/catalog-allowance.d.ts +2 -0
- package/dist/billing/catalog-plan.d.ts +2 -0
- package/dist/billing/catalog-plan.js +4 -0
- package/dist/billing/catalog.d.ts +7 -3
- package/dist/billing/catalog.js +1 -1
- package/dist/billing/subscription.d.ts +16 -2
- package/dist/date/range.d.ts +1 -0
- package/dist/date/range.js +1 -0
- package/dist/decimal/range.d.ts +1 -0
- package/dist/decimal/range.js +1 -0
- package/dist/directory/export-column-type.d.ts +67 -0
- package/dist/directory/export-column-type.js +40 -0
- package/dist/directory/export-mutation.d.ts +735 -0
- package/dist/directory/export-mutation.js +37 -0
- package/dist/directory/export.d.ts +50 -0
- package/dist/directory/export.js +24 -0
- package/dist/enrichment/enrichment.d.ts +2 -0
- package/dist/entity/filter-logo-option.d.ts +1 -0
- package/dist/entity/filter-logo-option.js +1 -0
- package/dist/entity/filter.d.ts +1 -0
- package/dist/entity/filter.js +1 -0
- package/dist/entity/fundraise-filter-criteria.d.ts +1 -0
- package/dist/entity/fundraise-filter-criteria.js +1 -0
- package/dist/entity/list-filter.d.ts +2 -0
- package/dist/entity/list-filter.js +2 -0
- package/dist/entity/list-quality-gate.d.ts +1 -0
- package/dist/entity/list-quality-gate.js +1 -0
- package/dist/entity/operating-status.d.ts +1 -0
- package/dist/entity/operating-status.js +1 -0
- package/dist/entity/person-association-filter.d.ts +1 -0
- package/dist/entity/person-association-filter.js +1 -0
- package/dist/entity/url-type.d.ts +2 -0
- package/dist/entity/url-type.js +2 -0
- package/dist/harness/run-detail.d.ts +2 -0
- package/dist/harness/run.d.ts +2 -0
- package/dist/http/problem-detail.d.ts +2 -0
- package/dist/identification/identification.d.ts +6 -0
- package/dist/identification/identification.js +5 -0
- package/dist/identification/subject.d.ts +1 -0
- package/dist/identification/subject.js +2 -0
- package/dist/int/range.d.ts +1 -0
- package/dist/int/range.js +1 -0
- package/dist/investor/activity-filter.d.ts +1 -0
- package/dist/investor/activity-filter.js +1 -0
- package/dist/investor/name-match-mode.d.ts +1 -0
- package/dist/investor/name-match-mode.js +1 -0
- package/dist/job/enqueue.d.ts +10 -10
- package/dist/job/enqueue.js +11 -7
- package/dist/lookup/job-mention.d.ts +6 -0
- package/dist/lookup/job-mutation.d.ts +1 -0
- package/dist/lookup/job-mutation.js +1 -1
- package/dist/lookup/job.d.ts +20 -0
- package/dist/lookup/job.js +1 -1
- package/dist/mention/lookup.d.ts +17 -0
- package/dist/mention/lookup.js +3 -0
- package/dist/openapi-component-manifest.js +9 -0
- package/dist/pagination/schemas.d.ts +2 -0
- package/dist/person/filter.d.ts +2 -0
- package/dist/person/filter.js +2 -0
- package/dist/person/list-array-filter.d.ts +1 -0
- package/dist/person/list-array-filter.js +1 -0
- package/dist/research/access-type.d.ts +1 -0
- package/dist/research/access-type.js +1 -0
- package/dist/research/allowance-type.d.ts +3 -1
- package/dist/research/allowance-type.js +2 -1
- package/dist/research/allowance-usage.d.ts +231 -130
- package/dist/research/allowance-usage.js +2 -0
- package/dist/research/allowance.d.ts +13 -16
- package/dist/research/allowance.js +13 -12
- package/dist/shared/directory-type.d.ts +3 -0
- package/dist/shared/directory-type.js +3 -0
- package/dist/unique/id-type.d.ts +15 -1
- package/dist/unique/id-type.js +8 -1
- package/dist/unique/id.d.ts +14 -0
- package/dist/url/match-mode.d.ts +1 -0
- package/dist/url/match-mode.js +1 -0
- package/package.json +1 -1
package/dist/lookup/job.js
CHANGED
|
@@ -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 /v1/lookup or POST /v1/entities/lookup returns for source.subject; absent otherwise. */
|
|
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. */
|
|
13
13
|
identification: IdentificationSchema.nullish(),
|
|
14
14
|
/** Lookup job id. */
|
|
15
15
|
jobId: z.uuid(),
|
package/dist/mention/lookup.d.ts
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
3
|
+
filing: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
4
|
+
jobId: z.ZodUUID;
|
|
5
|
+
mode: z.ZodString;
|
|
6
|
+
statusUrl: z.ZodString;
|
|
7
|
+
}, z.core.$strip>>>;
|
|
3
8
|
mention: z.ZodArray<z.ZodType<{
|
|
4
9
|
enrichmentRunId?: string | null | undefined;
|
|
5
10
|
entity: {
|
|
@@ -630,6 +635,12 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
630
635
|
website?: string | null | undefined;
|
|
631
636
|
}[];
|
|
632
637
|
enrichmentRunId?: string | null | undefined;
|
|
638
|
+
filing?: {
|
|
639
|
+
jobId: string;
|
|
640
|
+
mode: string;
|
|
641
|
+
statusUrl: string;
|
|
642
|
+
} | null | undefined;
|
|
643
|
+
inserted?: boolean | null | undefined;
|
|
633
644
|
languageModelSettled?: boolean | null | undefined;
|
|
634
645
|
match?: {
|
|
635
646
|
createdAt?: string | null | undefined;
|
|
@@ -1347,6 +1358,12 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
1347
1358
|
website?: string | null | undefined;
|
|
1348
1359
|
}[];
|
|
1349
1360
|
enrichmentRunId?: string | null | undefined;
|
|
1361
|
+
filing?: {
|
|
1362
|
+
jobId: string;
|
|
1363
|
+
mode: string;
|
|
1364
|
+
statusUrl: string;
|
|
1365
|
+
} | null | undefined;
|
|
1366
|
+
inserted?: boolean | null | undefined;
|
|
1350
1367
|
languageModelSettled?: boolean | null | undefined;
|
|
1351
1368
|
match?: {
|
|
1352
1369
|
createdAt?: string | null | undefined;
|
package/dist/mention/lookup.js
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
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
|
+
import { JobEnqueueSchema } from "../job/enqueue.js";
|
|
3
4
|
import { LookupJobMentionSchema } from "../lookup/job-mention.js";
|
|
4
5
|
const MentionLookupSchemaDefinition = z.object({
|
|
6
|
+
/** Present only for callers that sent Prefer: respond-async. Identifications are settled but shell filing is pending. Poll statusUrl until the lookup job completes; merge its filing outcomes by mentionType and name. */
|
|
7
|
+
filing: JobEnqueueSchema.nullish(),
|
|
5
8
|
/** Each distinct name: the page's own company first, then the order the source shows them, with news outlets and the page's bylined authors last. */
|
|
6
9
|
mention: z.array(LookupJobMentionSchema),
|
|
7
10
|
/** True when the page names more than this answer holds: more names than one live lookup reads, or a body longer than the read limit. A lookup job with maxNames reads every name. */
|
|
@@ -256,6 +256,15 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
256
256
|
},
|
|
257
257
|
DateRange: { modulePath: "date/range", schemaName: "DateRangeSchema" },
|
|
258
258
|
DecimalRange: { modulePath: "decimal/range", schemaName: "DecimalRangeSchema" },
|
|
259
|
+
DirectoryExport: { modulePath: "directory/export", schemaName: "DirectoryExportSchema" },
|
|
260
|
+
DirectoryExportColumnType: {
|
|
261
|
+
modulePath: "directory/export-column-type",
|
|
262
|
+
schemaName: "DirectoryExportColumnTypeSchema",
|
|
263
|
+
},
|
|
264
|
+
DirectoryExportMutation: {
|
|
265
|
+
modulePath: "directory/export-mutation",
|
|
266
|
+
schemaName: "DirectoryExportMutationSchema",
|
|
267
|
+
},
|
|
259
268
|
DomainConflictDetails: {
|
|
260
269
|
modulePath: "domain/conflict-details",
|
|
261
270
|
schemaName: "DomainConflictDetailsSchema",
|
|
@@ -10148,6 +10148,7 @@ declare const PageHarnessRunSchemaDefinition: z.ZodObject<{
|
|
|
10148
10148
|
COMPANY: "COMPANY";
|
|
10149
10149
|
ENTITY_BRAND: "ENTITY_BRAND";
|
|
10150
10150
|
ENTITY_VIEW: "ENTITY_VIEW";
|
|
10151
|
+
EXPORT: "EXPORT";
|
|
10151
10152
|
PERSON: "PERSON";
|
|
10152
10153
|
PERSON_VIEW: "PERSON_VIEW";
|
|
10153
10154
|
WEB_SEARCH: "WEB_SEARCH";
|
|
@@ -10156,6 +10157,7 @@ declare const PageHarnessRunSchemaDefinition: z.ZodObject<{
|
|
|
10156
10157
|
COMPANY: "COMPANY";
|
|
10157
10158
|
ENTITY_BRAND: "ENTITY_BRAND";
|
|
10158
10159
|
ENTITY_VIEW: "ENTITY_VIEW";
|
|
10160
|
+
EXPORT: "EXPORT";
|
|
10159
10161
|
PERSON: "PERSON";
|
|
10160
10162
|
PERSON_VIEW: "PERSON_VIEW";
|
|
10161
10163
|
WEB_SEARCH: "WEB_SEARCH";
|
package/dist/person/filter.d.ts
CHANGED
|
@@ -8,12 +8,14 @@ import { z } from "zod/v4";
|
|
|
8
8
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
9
9
|
* @endpoint GET /v1/search/shared/{id}
|
|
10
10
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
11
|
+
* @endpoint POST /v1/directory/exports
|
|
11
12
|
* @endpoint POST /v1/directory/shared
|
|
12
13
|
* @endpoint POST /v1/people/search
|
|
13
14
|
* @endpoint POST /v1/search
|
|
14
15
|
* @endpoint POST /v1/search/natural/entities
|
|
15
16
|
* @endpoint POST /v1/search/natural/people
|
|
16
17
|
* @endpoint POST /v1/search/shared
|
|
18
|
+
* @usedBySchema DirectoryExportMutationSchema
|
|
17
19
|
* @usedBySchema PersonNaturalSearchSchema
|
|
18
20
|
* @usedBySchema PersonSearchInterpretationSchema
|
|
19
21
|
* @usedBySchema SearchInterpretationSchema
|
package/dist/person/filter.js
CHANGED
|
@@ -13,12 +13,14 @@ import { PersonListArrayFilterSchema } from "./list-array-filter.js";
|
|
|
13
13
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
14
14
|
* @endpoint GET /v1/search/shared/{id}
|
|
15
15
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
16
|
+
* @endpoint POST /v1/directory/exports
|
|
16
17
|
* @endpoint POST /v1/directory/shared
|
|
17
18
|
* @endpoint POST /v1/people/search
|
|
18
19
|
* @endpoint POST /v1/search
|
|
19
20
|
* @endpoint POST /v1/search/natural/entities
|
|
20
21
|
* @endpoint POST /v1/search/natural/people
|
|
21
22
|
* @endpoint POST /v1/search/shared
|
|
23
|
+
* @usedBySchema DirectoryExportMutationSchema
|
|
22
24
|
* @usedBySchema PersonNaturalSearchSchema
|
|
23
25
|
* @usedBySchema PersonSearchInterpretationSchema
|
|
24
26
|
* @usedBySchema SearchInterpretationSchema
|
|
@@ -8,6 +8,7 @@ import { z } from "zod/v4";
|
|
|
8
8
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
9
9
|
* @endpoint GET /v1/search/shared/{id}
|
|
10
10
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
11
|
+
* @endpoint POST /v1/directory/exports
|
|
11
12
|
* @endpoint POST /v1/directory/shared
|
|
12
13
|
* @endpoint POST /v1/people/search
|
|
13
14
|
* @endpoint POST /v1/search
|
|
@@ -12,6 +12,7 @@ import { IntRangeSchema } from "../int/range.js";
|
|
|
12
12
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
13
13
|
* @endpoint GET /v1/search/shared/{id}
|
|
14
14
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
15
|
+
* @endpoint POST /v1/directory/exports
|
|
15
16
|
* @endpoint POST /v1/directory/shared
|
|
16
17
|
* @endpoint POST /v1/people/search
|
|
17
18
|
* @endpoint POST /v1/search
|
|
@@ -5,6 +5,7 @@ import { z } from "zod/v4";
|
|
|
5
5
|
* @openapiSchema ResearchAccessType
|
|
6
6
|
* @endpoint GET /v1/billing/ai-credits
|
|
7
7
|
* @endpoint GET /v1/billing/subscription
|
|
8
|
+
* @endpoint POST /v1/directory/exports
|
|
8
9
|
* @usedBySchema ResearchAllowanceSchema
|
|
9
10
|
* @contractShape research.access-type
|
|
10
11
|
* @contractRole canonical
|
|
@@ -13,6 +13,7 @@ const ResearchAccessTypeSchemaKnownMembers = z.enum([
|
|
|
13
13
|
* @openapiSchema ResearchAccessType
|
|
14
14
|
* @endpoint GET /v1/billing/ai-credits
|
|
15
15
|
* @endpoint GET /v1/billing/subscription
|
|
16
|
+
* @endpoint POST /v1/directory/exports
|
|
16
17
|
* @usedBySchema ResearchAllowanceSchema
|
|
17
18
|
* @contractShape research.access-type
|
|
18
19
|
* @contractRole canonical
|
|
@@ -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.
|
|
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.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema ResearchAllowanceType
|
|
6
6
|
* @standardProblemResponse
|
|
@@ -14,6 +14,7 @@ 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";
|
|
17
18
|
PERSON: "PERSON";
|
|
18
19
|
PERSON_VIEW: "PERSON_VIEW";
|
|
19
20
|
WEB_SEARCH: "WEB_SEARCH";
|
|
@@ -22,6 +23,7 @@ export declare const ResearchAllowanceTypeSchema: z.ZodUnion<readonly [z.ZodEnum
|
|
|
22
23
|
COMPANY: "COMPANY";
|
|
23
24
|
ENTITY_BRAND: "ENTITY_BRAND";
|
|
24
25
|
ENTITY_VIEW: "ENTITY_VIEW";
|
|
26
|
+
EXPORT: "EXPORT";
|
|
25
27
|
PERSON: "PERSON";
|
|
26
28
|
PERSON_VIEW: "PERSON_VIEW";
|
|
27
29
|
WEB_SEARCH: "WEB_SEARCH";
|
|
@@ -7,9 +7,10 @@ const ResearchAllowanceTypeSchemaKnownMembers = z.enum([
|
|
|
7
7
|
"ENTITY_BRAND",
|
|
8
8
|
"PERSON_VIEW",
|
|
9
9
|
"WEB_SEARCH",
|
|
10
|
+
"EXPORT",
|
|
10
11
|
]);
|
|
11
12
|
/**
|
|
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; `WEB_SEARCH` meters web searches.
|
|
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.
|
|
13
14
|
*
|
|
14
15
|
* @openapiSchema ResearchAllowanceType
|
|
15
16
|
* @standardProblemResponse
|
|
@@ -1,135 +1,236 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
declare const ResearchAllowanceUsageSchemaDefinition: z.ZodObject<{
|
|
3
|
-
company: z.
|
|
4
|
-
access
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
access
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
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>;
|
|
133
234
|
}, z.core.$strip>;
|
|
134
235
|
type ResearchAllowanceUsageDefinition = z.infer<typeof ResearchAllowanceUsageSchemaDefinition>;
|
|
135
236
|
export interface ResearchAllowanceUsageSchemaInput extends z.input<typeof ResearchAllowanceUsageSchemaDefinition> {
|
|
@@ -7,6 +7,8 @@ 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(),
|
|
10
12
|
/** Deprecated: replaced by company, which it mirrors. */
|
|
11
13
|
newCompany: ResearchAllowanceSchema,
|
|
12
14
|
/** Deprecated: replaced by person, which it mirrors. */
|
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
|
-
|
|
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<{
|
|
3
15
|
access: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
|
|
4
16
|
ADDITIONAL_USAGE: "ADDITIONAL_USAGE";
|
|
5
17
|
BILLING_BLOCKED: "BILLING_BLOCKED";
|
|
@@ -20,20 +32,5 @@ declare const ResearchAllowanceSchemaDefinition: z.ZodObject<{
|
|
|
20
32
|
resetAt: z.ZodISODateTime;
|
|
21
33
|
used: z.ZodInt;
|
|
22
34
|
}, 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 one billing period, the UTC month by default
|
|
28
|
-
*
|
|
29
|
-
* @openapiSchema ResearchAllowance
|
|
30
|
-
* @endpoint GET /v1/billing/ai-credits
|
|
31
|
-
* @endpoint GET /v1/billing/subscription
|
|
32
|
-
* @usedBySchema ResearchAllowanceUsageSchema
|
|
33
|
-
* @contractShape research.allowance
|
|
34
|
-
* @contractRole canonical
|
|
35
|
-
*/
|
|
36
|
-
export declare const ResearchAllowanceSchema: z.ZodType<ResearchAllowanceDefinition, ResearchAllowanceSchemaInput>;
|
|
37
35
|
export type ResearchAllowance = z.infer<typeof ResearchAllowanceSchema>;
|
|
38
|
-
export {};
|
|
39
36
|
//# sourceMappingURL=allowance.d.ts.map
|