@aventurevc/api-schemas 0.8.37 → 0.8.39
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/http/problem-detail.d.ts +3 -2
- package/dist/http/problem-detail.js +116 -111
- package/dist/lookup/job-mention.d.ts +1 -0
- package/dist/lookup/job-mention.js +2 -2
- package/dist/lookup/job-mutation.d.ts +4 -2
- package/dist/lookup/job.d.ts +6 -4
- package/dist/lookup/mention.d.ts +3 -1
- package/dist/lookup/mention.js +5 -3
- package/dist/mention/lookup.d.ts +2 -2
- package/package.json +1 -1
|
@@ -8,7 +8,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
8
8
|
WEB_SEARCH: "WEB_SEARCH";
|
|
9
9
|
}>>>;
|
|
10
10
|
circuitBreaker: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
11
|
-
code: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
11
|
+
code: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
|
|
12
12
|
GEOCODE_PROVIDER_ERROR: "GEOCODE_PROVIDER_ERROR";
|
|
13
13
|
INFERENCE_PROFILES_MISSING: "INFERENCE_PROFILES_MISSING";
|
|
14
14
|
INFERENCE_PROFILE_API_KEY_MISSING: "INFERENCE_PROFILE_API_KEY_MISSING";
|
|
@@ -52,6 +52,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
52
52
|
rbac_lookup_unavailable: "rbac_lookup_unavailable";
|
|
53
53
|
search_provider_error: "search_provider_error";
|
|
54
54
|
search_provider_not_configured: "search_provider_not_configured";
|
|
55
|
+
search_still_running: "search_still_running";
|
|
55
56
|
sec_edgar_fetch_failed: "sec_edgar_fetch_failed";
|
|
56
57
|
sentry_api_error: "sentry_api_error";
|
|
57
58
|
source_document_body_unavailable: "source_document_body_unavailable";
|
|
@@ -64,7 +65,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
64
65
|
suspected_shell_strip: "suspected_shell_strip";
|
|
65
66
|
url_surface_misclassification: "url_surface_misclassification";
|
|
66
67
|
web_crawl_fetch_failed: "web_crawl_fetch_failed";
|
|
67
|
-
}>>>;
|
|
68
|
+
}>, z.ZodString]>>>;
|
|
68
69
|
conflictingRecord: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
69
70
|
deletedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
70
71
|
id: z.ZodString;
|
|
@@ -13,117 +13,122 @@ const ProblemDetailSchemaDefinition = z.object({
|
|
|
13
13
|
circuitBreaker: z.string().nullish(),
|
|
14
14
|
/** Machine-readable secondary code on ProblemDetail.code. Agents should branch on this value when the HTTP status alone does not identify the recovery path. Code groups include auth/session, rate limiting, job infrastructure, RBAC, external providers, image processing, R2 storage, search, and inference. Many codes indicate infra/admin-only conditions where the correct agent action is to surface the error and stop, not retry. */
|
|
15
15
|
code: z
|
|
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
|
-
|
|
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
|
-
|
|
16
|
+
.union([
|
|
17
|
+
z.enum([
|
|
18
|
+
/** Caller is authenticated but lacks the required role for this operation. Agent action: surface the requiredRole field on the ProblemDetail and stop; do not retry without role escalation. */
|
|
19
|
+
"not_authorized",
|
|
20
|
+
/** Request was throttled. Agent action: wait at least retryAfterSeconds (also in the Retry-After header), then increase the delay exponentially on repeated 429s. When resetAt is present, wait until that time instead of retrying the exhausted monthly allowance. */
|
|
21
|
+
"rateLimited",
|
|
22
|
+
/** Request was throttled. Agent action: wait at least retryAfterSeconds (also in the Retry-After header), then increase the delay exponentially on repeated 429s. When resetAt is present, wait until that time instead of retrying the exhausted monthly allowance. */
|
|
23
|
+
"rate_limited",
|
|
24
|
+
/** Caller is authenticated but the subscription on their account does not include this operation. Agent action: surface ProblemDetail.detail explaining the subscription requirement and stop. The identical request cannot succeed until the account changes plan, so never retry it. */
|
|
25
|
+
"subscription_required",
|
|
26
|
+
/** Caller's subscription was canceled or its first payment expired unpaid, so it no longer includes this operation. Agent action: surface ProblemDetail.detail and stop; the account must subscribe again through the resolution's Checkout endpoint before the identical request can succeed. */
|
|
27
|
+
"subscription_canceled",
|
|
28
|
+
/** Caller's subscription has a failed or unfinished payment, so it does not include this operation until the payment succeeds. Agent action: surface ProblemDetail.detail and stop; the account must update its payment method through the resolution's Billing Portal endpoint. */
|
|
29
|
+
"subscription_past_due",
|
|
30
|
+
/** Caller's subscription is paused, so it does not include this operation. Agent action: surface ProblemDetail.detail and stop; the account must resume the subscription through the resolution's Billing Portal endpoint. */
|
|
31
|
+
"subscription_paused",
|
|
32
|
+
/** The caller's metered allowance for this operation is spent for the current period. Agent action: stop and report ProblemDetail.allowanceType, limit, used, remaining, and resetAt; resetAt is when the meter refills and is typically weeks away. Do not retry inside the period even though the status is 429. */
|
|
33
|
+
"billing_allowance_exhausted",
|
|
34
|
+
/** The caller's monthly allowance is spent and the next additional-usage unit would pass the monthly spend cap or the prepaid credit left. Agent action: stop and report ProblemDetail.allowanceType, limit, used, remaining, and resetAt; raise the cap or buy credit through /v1/billing/additional-usage, or wait for resetAt. */
|
|
35
|
+
"billing_additional_usage_cap_reached",
|
|
36
|
+
/** Detail-origin cold-miss coalescing is saturated. Agent action: treat as backend capacity impairment, back off, and inspect backend pool/bulkhead metrics; this is not a caller throttle. */
|
|
37
|
+
"origin_detail_capacity",
|
|
38
|
+
/** Detail-origin cold-miss scheduler rejected work because this instance is shutting down for a redeploy. Agent action: retry shortly; the platform routes the retry to a healthy instance. This is deploy-window noise, not a capacity defect — do not treat it as backend saturation. */
|
|
39
|
+
"origin_detail_shutdown",
|
|
40
|
+
/** Request prose looks shell-mangled around a money phrase: either shell expansion stripped a leading dollar sign ('50 million' where '$50 million' was meant) or an escape character survived into the text ('\$50 million', standalone '/$50 million'). Agent action: write '$' literally and re-send the JSON body from a file or stdin, or quote it so the shell does not expand '$'; use allowSuspectedShellStrip only when the value is intentional. */
|
|
41
|
+
"suspectedShellStrip",
|
|
42
|
+
/** Request prose looks shell-mangled around a money phrase: either shell expansion stripped a leading dollar sign ('50 million' where '$50 million' was meant) or an escape character survived into the text ('\$50 million', standalone '/$50 million'). Agent action: write '$' literally and re-send the JSON body from a file or stdin, or quote it so the shell does not expand '$'; use allowSuspectedShellStrip only when the value is intentional. */
|
|
43
|
+
"suspected_shell_strip",
|
|
44
|
+
/** A URL was submitted to the wrong write surface. Agent action: move the URL to the specific surface named by ProblemDetail.hint/resolution, for example EntityUrl.urlType=ycombinator via entities urls create instead of News.newsUrlOriginal. */
|
|
45
|
+
"url_surface_misclassification",
|
|
46
|
+
/** JobRunr background worker is disabled in this environment. Agent action: stop (this is an admin/ops configuration condition, not a retriable user error). */
|
|
47
|
+
"JOBRUNR_DISABLED",
|
|
48
|
+
/** JobRunr background worker is disabled in this environment. Agent action: stop (this is an admin/ops configuration condition, not a retriable user error). */
|
|
49
|
+
"jobrunr_disabled",
|
|
50
|
+
/** JobRunr backing storage (Postgres) is unavailable. Agent action: stop; retrying will not help until DB connectivity is restored. */
|
|
51
|
+
"JOBRUNR_STORAGE_UNAVAILABLE",
|
|
52
|
+
/** JobRunr backing storage (Postgres) is unavailable. Agent action: stop; retrying will not help until DB connectivity is restored. */
|
|
53
|
+
"jobrunr_storage_unavailable",
|
|
54
|
+
/** RBAC role lookup failed (app_user read did not return). Agent action: retry once; persistent failure indicates a database outage. */
|
|
55
|
+
"rbac_lookup_unavailable",
|
|
56
|
+
/** Geocoding provider (Google Maps Platform) call failed. Agent action: surface the error; address fields can be submitted without normalization as a fallback. */
|
|
57
|
+
"GEOCODE_PROVIDER_ERROR",
|
|
58
|
+
/** Geocoding provider (Google Maps Platform) call failed. Agent action: surface the error; address fields can be submitted without normalization as a fallback. */
|
|
59
|
+
"geocode_provider_error",
|
|
60
|
+
/** Sentry API call failed (used by error-triage endpoints). Agent action: surface; Sentry outages do not affect the primary application path. */
|
|
61
|
+
"sentry_api_error",
|
|
62
|
+
/** Frontend cache epoch requires the cache invalidation outbox consumer to run in targeted mode. Agent action: stop polling; this 503 is a designed cutover guard, and only the operator switching the outbox mode to targeted (docs/database/cache-invalidation.md) makes the epoch readable. */
|
|
63
|
+
"frontend_cache_epoch_mode_not_targeted",
|
|
64
|
+
/** Image upload matched a blocklist entry (visually similar to a known bad asset). Agent action: do not retry the same image; supply a different image or stop. */
|
|
65
|
+
"image_blocklist_match",
|
|
66
|
+
/** Image upload was blank or a flat monochrome canvas. Agent action: supply a source image with visible logo or photo detail; retrying the same bytes will not pass. */
|
|
67
|
+
"image_monochrome",
|
|
68
|
+
/** Image upload failed minimum dimension/file-size check. Agent action: supply a higher-resolution source image; retrying the same one will not pass. */
|
|
69
|
+
"image_too_small",
|
|
70
|
+
/** Image upload's visible content is a wide banner/wordmark when a square logo or photo was required. Agent action: supply a square (or near-square) source image — a favicon, app icon, square logo, or cropped headshot — not a horizontal wordmark or og:image banner; retrying the same bytes will not pass. */
|
|
71
|
+
"image_wrong_aspect",
|
|
72
|
+
/** Image upload was classified as a monogram (single letter / generated initial) when a real photograph or logo was required. Agent action: supply a non-monogram image or set permitMonogram=true on the read endpoint if a monogram is acceptable for the use case. */
|
|
73
|
+
"image_monogram",
|
|
74
|
+
/** Image upload could not be decoded (corrupt file, unsupported format). Agent action: supply a valid PNG/JPEG/WebP; retrying the same bytes will not pass. */
|
|
75
|
+
"image_unreadable",
|
|
76
|
+
/** Image processing pipeline (resize/encode/hash) threw an unexpected error. Agent action: retry once; persistent failure indicates an infra issue. */
|
|
77
|
+
"image_processing_error",
|
|
78
|
+
/** Logo/photo upload was rejected because the server-side brand-match vision check found it does not depict the target's own brand (a generic favicon, a parent/provider/acquirer mark, an OpenGraph/banner/social card, or an unrelated image). Agent action: supply the target entity's OWN brand mark and re-run; retrying the same image, or any generic/og/banner/parent asset, will not pass. */
|
|
79
|
+
"image_brand_mismatch",
|
|
80
|
+
/** An outbound fetch from an external target site (robots.txt, sitemap, page, or logo or thumbnail image) failed after retries or with the breaker open. Agent action: the failure belongs to the target; crawl jobs may fall back to rendered extraction; do not retry immediately. */
|
|
81
|
+
"web_crawl_fetch_failed",
|
|
82
|
+
/** A crawl-run request named an entity or person that has no current primary website URL. Agent action: add or activate the owner's website URL, then resubmit; retrying the unchanged request cannot succeed. */
|
|
83
|
+
"primary_website_missing",
|
|
84
|
+
/** RSS news-ingest feed fetch failed after retries or with the breaker open. Agent action: inspect the configured feed URL and upstream status; do not retry the enqueue immediately. */
|
|
85
|
+
"news_rss_feed_fetch_failed",
|
|
86
|
+
/** RSS news-ingest article page fetch failed after retries or with the breaker open. Agent action: inspect the source article URL and upstream status; the ingest job may skip that article. */
|
|
87
|
+
"news_rss_article_fetch_failed",
|
|
88
|
+
/** Cloudflare R2 object fetch failed during a read operation. Agent action: retry once with backoff; persistent failure indicates R2 outage or asset deletion. */
|
|
89
|
+
"r2_fetch_failed",
|
|
90
|
+
/** Cloudflare R2 object delete failed during a cleanup operation. Agent action: surface; retrying may produce duplicate-delete errors. */
|
|
91
|
+
"r2_delete_failed",
|
|
92
|
+
/** Cloudflare R2 object upload failed during a write operation. Agent action: retry once with the same payload; persistent failure indicates R2 outage. */
|
|
93
|
+
"r2_upload_failed",
|
|
94
|
+
/** Stored source-document raw bytes could not be served: the row's inline-or-R2 raw authority is incomplete or failed digest verification. Agent action: surface; the stored authority needs operator reconciliation before this body can be read. */
|
|
95
|
+
"source_document_body_unavailable",
|
|
96
|
+
/** A source-document capture stopped before retaining a provider response over this service's configured byte limit. Agent action: this is a designed containment boundary, not a provider outage or a service defect; do not retry the same request expecting a different outcome. */
|
|
97
|
+
"source_document_capture_limit_exceeded",
|
|
98
|
+
/** News similarity cannot run because the target embedding is unavailable or live similarity capacity is full. Agent action: surface the 503 and retry later; this endpoint does not fall back to lexical ranking. */
|
|
99
|
+
"news_similarity_embedding_unavailable",
|
|
100
|
+
/** 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. */
|
|
101
|
+
"search_provider_not_configured",
|
|
102
|
+
/** Search provider call failed. Agent action: surface; provider outages affect search endpoints only. */
|
|
103
|
+
"search_provider_error",
|
|
104
|
+
/** 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. */
|
|
105
|
+
"search_still_running",
|
|
106
|
+
/** SEC EDGAR lookup failed (ticker catalog or company submissions). Agent action: surface; SEC outages or rate limiting affect the public-company preview endpoint only. */
|
|
107
|
+
"sec_edgar_fetch_failed",
|
|
108
|
+
/** GitHub repository fetch failed (account, listing, or single repo). Agent action: surface; GitHub outages or rate limiting affect github-repo sync endpoints only. */
|
|
109
|
+
"github_fetch_failed",
|
|
110
|
+
/** LLM inference provider call failed. Agent action: retry once with backoff; persistent failure indicates provider outage or invalid profile config. */
|
|
111
|
+
"INFERENCE_PROVIDER_ERROR",
|
|
112
|
+
/** LLM inference provider call failed. Agent action: retry once with backoff; persistent failure indicates provider outage or invalid profile config. */
|
|
113
|
+
"inference_provider_error",
|
|
114
|
+
/** LLM inference provider returned an empty response body. Agent action: retry once; persistent empty responses indicate prompt or provider misconfiguration. */
|
|
115
|
+
"INFERENCE_PROVIDER_RESPONSE_EMPTY",
|
|
116
|
+
/** LLM inference provider returned an empty response body. Agent action: retry once; persistent empty responses indicate prompt or provider misconfiguration. */
|
|
117
|
+
"inference_provider_response_empty",
|
|
118
|
+
/** LLM inference provider returned a response that failed JSON parsing. Agent action: surface; the prompt or response schema may need adjustment. */
|
|
119
|
+
"INFERENCE_PROVIDER_INVALID_JSON",
|
|
120
|
+
/** LLM inference provider returned a response that failed JSON parsing. Agent action: surface; the prompt or response schema may need adjustment. */
|
|
121
|
+
"inference_provider_invalid_json",
|
|
122
|
+
/** Inference profile catalog is missing or empty. Agent action: stop; admin/ops must configure inference profiles before this endpoint will succeed. */
|
|
123
|
+
"INFERENCE_PROFILES_MISSING",
|
|
124
|
+
/** Inference profile catalog is missing or empty. Agent action: stop; admin/ops must configure inference profiles before this endpoint will succeed. */
|
|
125
|
+
"inference_profiles_missing",
|
|
126
|
+
/** Inference profile is configured but its API key is missing from secret storage. Agent action: stop; admin/ops must populate the API key in secret storage. */
|
|
127
|
+
"INFERENCE_PROFILE_API_KEY_MISSING",
|
|
128
|
+
/** Inference profile is configured but its API key is missing from secret storage. Agent action: stop; admin/ops must populate the API key in secret storage. */
|
|
129
|
+
"inference_profile_api_key_missing",
|
|
130
|
+
]),
|
|
131
|
+
z.string().max(128),
|
|
127
132
|
])
|
|
128
133
|
.nullish(),
|
|
129
134
|
conflictingRecord: CurrentSlugOwnerSchema.nullish(),
|
|
@@ -1078,6 +1078,7 @@ declare const LookupJobMentionSchemaDefinition: z.ZodObject<{
|
|
|
1078
1078
|
mentionType: z.ZodEnum<{
|
|
1079
1079
|
COMPANY: "COMPANY";
|
|
1080
1080
|
PERSON: "PERSON";
|
|
1081
|
+
PRODUCT_SERVICE: "PRODUCT_SERVICE";
|
|
1081
1082
|
}>;
|
|
1082
1083
|
name: z.ZodString;
|
|
1083
1084
|
person: z.ZodArray<z.ZodType<{
|
|
@@ -13,8 +13,8 @@ const LookupJobMentionSchemaDefinition = z.object({
|
|
|
13
13
|
failureReason: z.string().nullish(),
|
|
14
14
|
/** The lookup of this name with the source as its context: MATCHED names the stored record, NEEDS_REVIEW lists the candidates, NO_MATCH means none is stored. Absent when failureReason is set. */
|
|
15
15
|
identification: IdentificationSchema.nullish(),
|
|
16
|
-
/** Whether the source names a company or a person. */
|
|
17
|
-
mentionType: z.enum(["COMPANY", "PERSON"]),
|
|
16
|
+
/** Whether the source names a company, a Product or Service, or a person. */
|
|
17
|
+
mentionType: z.enum(["COMPANY", "PERSON", "PRODUCT_SERVICE"]),
|
|
18
18
|
/** Name as the source writes it. */
|
|
19
19
|
name: z.string(),
|
|
20
20
|
/** POST /v1/lookup-mentions only: the candidate people as search results show them, ranked like entity. */
|
|
@@ -2,12 +2,14 @@ import { z } from "zod/v4";
|
|
|
2
2
|
declare const LookupJobMutationSchemaDefinition: z.ZodObject<{
|
|
3
3
|
mention: z.ZodOptional<z.ZodArray<z.ZodType<{
|
|
4
4
|
name: string;
|
|
5
|
+
providerName?: string | null | undefined;
|
|
5
6
|
searchQuery?: string | undefined;
|
|
6
|
-
type: "COMPANY" | "PERSON";
|
|
7
|
+
type: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
7
8
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
8
9
|
name: string;
|
|
10
|
+
providerName?: string | null | undefined;
|
|
9
11
|
searchQuery?: string | undefined;
|
|
10
|
-
type: "COMPANY" | "PERSON";
|
|
12
|
+
type: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
11
13
|
}, unknown>>>>;
|
|
12
14
|
sourceNewsId: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
13
15
|
sourceUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
package/dist/lookup/job.d.ts
CHANGED
|
@@ -557,7 +557,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
557
557
|
stage: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE";
|
|
558
558
|
status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
|
|
559
559
|
} | null | undefined;
|
|
560
|
-
mentionType: "COMPANY" | "PERSON";
|
|
560
|
+
mentionType: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
561
561
|
name: string;
|
|
562
562
|
person: {
|
|
563
563
|
createdAt?: string | null | undefined;
|
|
@@ -1157,7 +1157,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
1157
1157
|
stage: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE";
|
|
1158
1158
|
status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
|
|
1159
1159
|
} | null | undefined;
|
|
1160
|
-
mentionType: "COMPANY" | "PERSON";
|
|
1160
|
+
mentionType: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
1161
1161
|
name: string;
|
|
1162
1162
|
person: {
|
|
1163
1163
|
createdAt?: string | null | undefined;
|
|
@@ -1211,16 +1211,18 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
1211
1211
|
source: z.ZodType<{
|
|
1212
1212
|
mention?: {
|
|
1213
1213
|
name: string;
|
|
1214
|
+
providerName?: string | null | undefined;
|
|
1214
1215
|
searchQuery?: string | undefined;
|
|
1215
|
-
type: "COMPANY" | "PERSON";
|
|
1216
|
+
type: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
1216
1217
|
}[] | undefined;
|
|
1217
1218
|
sourceNewsId?: number | null | undefined;
|
|
1218
1219
|
sourceUrl?: string | null | undefined;
|
|
1219
1220
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
1220
1221
|
mention?: {
|
|
1221
1222
|
name: string;
|
|
1223
|
+
providerName?: string | null | undefined;
|
|
1222
1224
|
searchQuery?: string | undefined;
|
|
1223
|
-
type: "COMPANY" | "PERSON";
|
|
1225
|
+
type: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
1224
1226
|
}[] | undefined;
|
|
1225
1227
|
sourceNewsId?: number | null | undefined;
|
|
1226
1228
|
sourceUrl?: string | null | undefined;
|
package/dist/lookup/mention.d.ts
CHANGED
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
declare const LookupMentionSchemaDefinition: z.ZodObject<{
|
|
3
3
|
name: z.ZodString;
|
|
4
|
+
providerName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
4
5
|
searchQuery: z.ZodOptional<z.ZodString>;
|
|
5
6
|
type: z.ZodEnum<{
|
|
6
7
|
COMPANY: "COMPANY";
|
|
7
8
|
PERSON: "PERSON";
|
|
9
|
+
PRODUCT_SERVICE: "PRODUCT_SERVICE";
|
|
8
10
|
}>;
|
|
9
11
|
}, z.core.$strip>;
|
|
10
12
|
type LookupMentionDefinition = z.infer<typeof LookupMentionSchemaDefinition>;
|
|
11
13
|
/**
|
|
12
|
-
* One company or person a caller read from a page or screenshot it did not send.
|
|
14
|
+
* One company, Product or Service, or person a caller read from a page or screenshot it did not send.
|
|
13
15
|
*
|
|
14
16
|
* @openapiSchema LookupMention
|
|
15
17
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
package/dist/lookup/mention.js
CHANGED
|
@@ -3,13 +3,15 @@ import { z } from "zod/v4";
|
|
|
3
3
|
const LookupMentionSchemaDefinition = z.object({
|
|
4
4
|
/** Name as the source writes it. */
|
|
5
5
|
name: z.string(),
|
|
6
|
+
/** PRODUCT_SERVICE only: the organization that offers it, as the source writes it. When the offering resolves among offerings and its provider settles on an organization record, the match is limited to that record's offerings. */
|
|
7
|
+
providerName: z.string().nullish(),
|
|
6
8
|
/** Ignored: the lookup searches by name. Still accepted so callers that send it keep working; omit it. */
|
|
7
9
|
searchQuery: z.string().optional(),
|
|
8
|
-
/** Whether the source names a company or a person. */
|
|
9
|
-
type: z.enum(["COMPANY", "PERSON"]),
|
|
10
|
+
/** Whether the source names a company, a Product or Service (PRODUCT_SERVICE), or a person. A Product or Service resolves like a company first, then among Product and Service records when that finds no match, and never files a shell. */
|
|
11
|
+
type: z.enum(["COMPANY", "PERSON", "PRODUCT_SERVICE"]),
|
|
10
12
|
});
|
|
11
13
|
/**
|
|
12
|
-
* One company or person a caller read from a page or screenshot it did not send.
|
|
14
|
+
* One company, Product or Service, or person a caller read from a page or screenshot it did not send.
|
|
13
15
|
*
|
|
14
16
|
* @openapiSchema LookupMention
|
|
15
17
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
package/dist/mention/lookup.d.ts
CHANGED
|
@@ -552,7 +552,7 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
552
552
|
stage: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE";
|
|
553
553
|
status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
|
|
554
554
|
} | null | undefined;
|
|
555
|
-
mentionType: "COMPANY" | "PERSON";
|
|
555
|
+
mentionType: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
556
556
|
name: string;
|
|
557
557
|
person: {
|
|
558
558
|
createdAt?: string | null | undefined;
|
|
@@ -1152,7 +1152,7 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
1152
1152
|
stage: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE";
|
|
1153
1153
|
status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
|
|
1154
1154
|
} | null | undefined;
|
|
1155
|
-
mentionType: "COMPANY" | "PERSON";
|
|
1155
|
+
mentionType: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
1156
1156
|
name: string;
|
|
1157
1157
|
person: {
|
|
1158
1158
|
createdAt?: string | null | undefined;
|