lumnisai 0.5.32 → 0.5.33
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/index.cjs +68 -0
- package/dist/index.d.cts +164 -6
- package/dist/index.d.mts +164 -6
- package/dist/index.d.ts +164 -6
- package/dist/index.mjs +68 -0
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -3396,6 +3396,32 @@ class ResponsesResource {
|
|
|
3396
3396
|
}
|
|
3397
3397
|
}
|
|
3398
3398
|
}
|
|
3399
|
+
_validateEngagementExpansionParams(params) {
|
|
3400
|
+
const expandFromResponse = this._getParamValue(
|
|
3401
|
+
params,
|
|
3402
|
+
"expandFromResponse",
|
|
3403
|
+
"expand_from_response"
|
|
3404
|
+
);
|
|
3405
|
+
if (typeof expandFromResponse !== "string" || !expandFromResponse.trim()) {
|
|
3406
|
+
throw new ValidationError(
|
|
3407
|
+
"expandFromResponse is required for engagement_expansion and must be a non-empty string"
|
|
3408
|
+
);
|
|
3409
|
+
}
|
|
3410
|
+
for (const [camel, snake] of [
|
|
3411
|
+
["hops", "hops"],
|
|
3412
|
+
["postsPerHop", "posts_per_hop"],
|
|
3413
|
+
["peoplePerNextHop", "people_per_next_hop"],
|
|
3414
|
+
["limit", "limit"]
|
|
3415
|
+
]) {
|
|
3416
|
+
const value = this._getParamValue(params, camel, snake);
|
|
3417
|
+
if (value !== void 0 && (!Number.isInteger(value) || value < 1))
|
|
3418
|
+
throw new ValidationError(`${camel} must be a positive integer for engagement_expansion`);
|
|
3419
|
+
}
|
|
3420
|
+
const excludeUrls = this._getParamValue(params, "excludeUrls", "exclude_urls");
|
|
3421
|
+
if (excludeUrls !== void 0 && (!Array.isArray(excludeUrls) || excludeUrls.some((url) => typeof url !== "string"))) {
|
|
3422
|
+
throw new ValidationError("excludeUrls must be an array of strings for engagement_expansion");
|
|
3423
|
+
}
|
|
3424
|
+
}
|
|
3399
3425
|
_validateCriteriaParams(params, specializedAgent) {
|
|
3400
3426
|
if (!params)
|
|
3401
3427
|
return;
|
|
@@ -3509,6 +3535,8 @@ class ResponsesResource {
|
|
|
3509
3535
|
this._validateCompetitorRepEngagementParams(rawParams);
|
|
3510
3536
|
if (specializedAgent === "content_intelligence")
|
|
3511
3537
|
this._validateContentIntelligenceParams(rawParams);
|
|
3538
|
+
if (specializedAgent === "engagement_expansion")
|
|
3539
|
+
this._validateEngagementExpansionParams(rawParams);
|
|
3512
3540
|
}
|
|
3513
3541
|
_validateFileReference(uri) {
|
|
3514
3542
|
if (uri.startsWith("artifact_"))
|
|
@@ -3857,6 +3885,46 @@ class ResponsesResource {
|
|
|
3857
3885
|
specializedAgentParams: params
|
|
3858
3886
|
});
|
|
3859
3887
|
}
|
|
3888
|
+
/**
|
|
3889
|
+
* Find new people by walking outward from a saved content-intelligence package.
|
|
3890
|
+
*
|
|
3891
|
+
* Hop 1 pulls the other engagers of the package's best posts. Additional hops
|
|
3892
|
+
* select the highest-fit new people, rank posts from their feeds, and pull the
|
|
3893
|
+
* engagers of those posts. Collection breadth is derived from `limit` unless
|
|
3894
|
+
* `postsPerHop` is set explicitly. At the default limit, collection is about
|
|
3895
|
+
* 300 credits for one hop and 1,060 for three hops; enrichment and validation
|
|
3896
|
+
* use the standard deep-search economics on top.
|
|
3897
|
+
*
|
|
3898
|
+
* @param query - Persona prompt used to rank and validate discovered people.
|
|
3899
|
+
* @param options - Source response plus hop, breadth, limit, and exclusion controls.
|
|
3900
|
+
* @returns Response; poll with `get()` and read `structuredResponse` as
|
|
3901
|
+
* {@link EngagementExpansionOutput}.
|
|
3902
|
+
*/
|
|
3903
|
+
async engagementExpansion(query, options) {
|
|
3904
|
+
if (!query.trim())
|
|
3905
|
+
throw new ValidationError("engagementExpansion requires a non-empty persona query");
|
|
3906
|
+
const params = {
|
|
3907
|
+
expandFromResponse: options?.expandFromResponse
|
|
3908
|
+
};
|
|
3909
|
+
if (options?.hops !== void 0)
|
|
3910
|
+
params.hops = options.hops;
|
|
3911
|
+
if (options?.postsPerHop !== void 0)
|
|
3912
|
+
params.postsPerHop = options.postsPerHop;
|
|
3913
|
+
if (options?.peoplePerNextHop !== void 0)
|
|
3914
|
+
params.peoplePerNextHop = options.peoplePerNextHop;
|
|
3915
|
+
if (options?.limit !== void 0)
|
|
3916
|
+
params.limit = options.limit;
|
|
3917
|
+
if (options?.excludeUrls !== void 0)
|
|
3918
|
+
params.excludeUrls = options.excludeUrls;
|
|
3919
|
+
if (options?.deepValidationUseRelevanceReranker !== void 0) {
|
|
3920
|
+
params.deepValidationUseRelevanceReranker = options.deepValidationUseRelevanceReranker;
|
|
3921
|
+
}
|
|
3922
|
+
return this.create({
|
|
3923
|
+
messages: [{ role: "user", content: query }],
|
|
3924
|
+
specializedAgent: "engagement_expansion",
|
|
3925
|
+
specializedAgentParams: params
|
|
3926
|
+
});
|
|
3927
|
+
}
|
|
3860
3928
|
/**
|
|
3861
3929
|
* Score people who reacted to or commented on competitor LinkedIn posts.
|
|
3862
3930
|
*
|
package/dist/index.d.cts
CHANGED
|
@@ -836,8 +836,17 @@ interface ResolvedCompetitorTarget {
|
|
|
836
836
|
* provenance (competitor, author, date). Multiple posts → multiple entries.
|
|
837
837
|
*/
|
|
838
838
|
interface PostEngagementData {
|
|
839
|
+
/** Stable package key for the source post (engagement expansion). */
|
|
840
|
+
postKey?: string;
|
|
839
841
|
/** LinkedIn post URL the person engaged with */
|
|
840
842
|
postUrl: string;
|
|
843
|
+
/** Full source-post text when retained by the lane. */
|
|
844
|
+
postText?: string | null;
|
|
845
|
+
/** Source-post publication date; reaction payloads do not provide per-person timestamps. */
|
|
846
|
+
postPublished?: string | {
|
|
847
|
+
kind?: string;
|
|
848
|
+
value?: string;
|
|
849
|
+
} | null;
|
|
841
850
|
/** How the person engaged */
|
|
842
851
|
role: 'reactor' | 'commenter';
|
|
843
852
|
/** Reaction type for reactors (e.g. LIKE, PRAISE, EMPATHY) */
|
|
@@ -850,12 +859,22 @@ interface PostEngagementData {
|
|
|
850
859
|
postAuthorType?: 'company' | 'exec';
|
|
851
860
|
/** Name of the post author (company or exec) */
|
|
852
861
|
postAuthorName?: string;
|
|
862
|
+
/** Source-post author name used by engagement expansion. */
|
|
863
|
+
postAuthor?: string;
|
|
853
864
|
/** LinkedIn URL of the post author */
|
|
854
865
|
postAuthorUrl?: string;
|
|
855
866
|
/** ISO timestamp of the post */
|
|
856
867
|
postDate?: string;
|
|
857
868
|
/** Total engagement on the post (reactions + comments) at selection time */
|
|
858
869
|
engagementScore?: number;
|
|
870
|
+
/** One-based expansion hop that discovered this edge. */
|
|
871
|
+
hop?: number;
|
|
872
|
+
/** Expansion walk strategy that produced the edge. */
|
|
873
|
+
walk?: 'post_coengagement' | string;
|
|
874
|
+
/** Relevance assigned to the source post during curation. */
|
|
875
|
+
postRelevance?: number | null;
|
|
876
|
+
/** Source-package audience members who also engaged with this post. */
|
|
877
|
+
audienceEngagers?: string[];
|
|
859
878
|
[key: string]: any;
|
|
860
879
|
}
|
|
861
880
|
/** @deprecated Use {@link PostEngagementData} */
|
|
@@ -1165,6 +1184,8 @@ interface ContentIntelligencePost {
|
|
|
1165
1184
|
relevance?: number | null;
|
|
1166
1185
|
totalReactions?: number | null;
|
|
1167
1186
|
totalComments?: number | null;
|
|
1187
|
+
/** Whether the source post includes video. The backend does not expose the media URL. */
|
|
1188
|
+
hasVideo?: boolean;
|
|
1168
1189
|
hybridScore?: number;
|
|
1169
1190
|
}
|
|
1170
1191
|
interface ContentIntelligencePackage {
|
|
@@ -1193,6 +1214,12 @@ interface PostIdea {
|
|
|
1193
1214
|
idea: string;
|
|
1194
1215
|
angle: string;
|
|
1195
1216
|
citedPostKeys: string[];
|
|
1217
|
+
/** Clickable source posts that inspired the idea. */
|
|
1218
|
+
citedPosts: Array<{
|
|
1219
|
+
key: string;
|
|
1220
|
+
url?: string | null;
|
|
1221
|
+
author?: string | null;
|
|
1222
|
+
}>;
|
|
1196
1223
|
draft: string;
|
|
1197
1224
|
probability: number;
|
|
1198
1225
|
keysExist: number;
|
|
@@ -1387,6 +1414,84 @@ interface ContentIntelligenceOutput {
|
|
|
1387
1414
|
agentParams: ContentIntelligenceResolvedParams;
|
|
1388
1415
|
}
|
|
1389
1416
|
|
|
1417
|
+
/** Options accepted by {@link ResponsesResource.engagementExpansion}. */
|
|
1418
|
+
interface EngagementExpansionOptions {
|
|
1419
|
+
/** Finished content_intelligence response whose saved package seeds the walk. */
|
|
1420
|
+
expandFromResponse: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* Number of outward rounds to run. At the default limit, collection is
|
|
1423
|
+
* approximately 300 credits for one hop and 1,060 for three hops.
|
|
1424
|
+
* Enrichment and validation are additional. @default 1
|
|
1425
|
+
*/
|
|
1426
|
+
hops?: number;
|
|
1427
|
+
/**
|
|
1428
|
+
* Answering posts to collect per hop at 5 credits each. Omit to derive
|
|
1429
|
+
* breadth from `limit`: limits 25 or 50 derive 60 posts (300 credits),
|
|
1430
|
+
* while limit 200 derives 240 posts (1,200 credits).
|
|
1431
|
+
*/
|
|
1432
|
+
postsPerHop?: number;
|
|
1433
|
+
/** Highest-fit people whose feeds seed the next hop. Ignored for one hop. @default 20 */
|
|
1434
|
+
peoplePerNextHop?: number;
|
|
1435
|
+
/** Maximum validated people returned. @default 50 */
|
|
1436
|
+
limit?: number;
|
|
1437
|
+
/** LinkedIn profile URLs excluded in addition to the source package's audience. */
|
|
1438
|
+
excludeUrls?: string[];
|
|
1439
|
+
/** SLM relevance reranker for surfaced candidates. @default true */
|
|
1440
|
+
deepValidationUseRelevanceReranker?: boolean;
|
|
1441
|
+
}
|
|
1442
|
+
/** Resolved parameters echoed in `structuredResponse.agentParams`. */
|
|
1443
|
+
interface EngagementExpansionResolvedParams {
|
|
1444
|
+
expandFromResponse: string;
|
|
1445
|
+
hops: number;
|
|
1446
|
+
postsPerHop?: number | null;
|
|
1447
|
+
peoplePerNextHop: number;
|
|
1448
|
+
limit: number;
|
|
1449
|
+
excludeUrls?: string[] | null;
|
|
1450
|
+
}
|
|
1451
|
+
/** Collection statistics for one expansion hop. */
|
|
1452
|
+
interface EngagementExpansionHopStats {
|
|
1453
|
+
hop: number;
|
|
1454
|
+
postsPulled: number;
|
|
1455
|
+
newPeople: number;
|
|
1456
|
+
refinds: number;
|
|
1457
|
+
refindsMergedAsNewEdges: number;
|
|
1458
|
+
authorColleaguesExcluded: number;
|
|
1459
|
+
credits: number;
|
|
1460
|
+
stopReason: string;
|
|
1461
|
+
}
|
|
1462
|
+
/** Collection and finalist-history accounting for an expansion run. */
|
|
1463
|
+
interface EngagementExpansionStats {
|
|
1464
|
+
hopsRun: number;
|
|
1465
|
+
hopsRequested: number;
|
|
1466
|
+
postsPerHop: number;
|
|
1467
|
+
postsPerHopSource: 'requested' | 'derived';
|
|
1468
|
+
/** Hop collection only; enrichment and validation use standard deep-search economics. */
|
|
1469
|
+
collectionCreditsSpent: number;
|
|
1470
|
+
collectionCreditCeiling: number;
|
|
1471
|
+
stopReason: string;
|
|
1472
|
+
perHop: EngagementExpansionHopStats[];
|
|
1473
|
+
/** Credits spent loading broader engagement history for finalists. */
|
|
1474
|
+
finalistHistoryCredits?: number;
|
|
1475
|
+
/** Finalists for whom broader engagement history was available. */
|
|
1476
|
+
finalistsWithHistory?: number;
|
|
1477
|
+
}
|
|
1478
|
+
/** A recent LinkedIn reaction used to give validation broader behavioral context. */
|
|
1479
|
+
interface EngagementHistoryEntry {
|
|
1480
|
+
when?: string | null;
|
|
1481
|
+
reactionType?: string | null;
|
|
1482
|
+
postAuthor?: string | null;
|
|
1483
|
+
postUrl?: string | null;
|
|
1484
|
+
postText?: string | null;
|
|
1485
|
+
}
|
|
1486
|
+
/** Full structured output from a succeeded `engagement_expansion` run. */
|
|
1487
|
+
interface EngagementExpansionOutput {
|
|
1488
|
+
/** Validated candidates, preserving the backend's scoring order and capped to `limit`. */
|
|
1489
|
+
candidates: ValidatedCandidate[];
|
|
1490
|
+
criteria?: CriteriaMetadata;
|
|
1491
|
+
expansionStats?: EngagementExpansionStats;
|
|
1492
|
+
agentParams: EngagementExpansionResolvedParams;
|
|
1493
|
+
}
|
|
1494
|
+
|
|
1390
1495
|
/**
|
|
1391
1496
|
* Available people search data sources
|
|
1392
1497
|
*/
|
|
@@ -1815,6 +1920,12 @@ interface ValidatedCandidate {
|
|
|
1815
1920
|
currentCompany?: string;
|
|
1816
1921
|
/** Location */
|
|
1817
1922
|
location?: string;
|
|
1923
|
+
/** Location resolved by validation, including an evidence-based inference when needed. */
|
|
1924
|
+
primaryLocation?: string | null;
|
|
1925
|
+
/** Evidence and reasoning used to resolve `primaryLocation`. */
|
|
1926
|
+
locationReasoning?: string | null;
|
|
1927
|
+
/** Provenance for an inferred `location`, such as `inferred:validation`. */
|
|
1928
|
+
locationSource?: string | null;
|
|
1818
1929
|
/** Profile picture URL */
|
|
1819
1930
|
profilePictureUrl?: string;
|
|
1820
1931
|
/** Overall match score (0-10) */
|
|
@@ -1827,6 +1938,8 @@ interface ValidatedCandidate {
|
|
|
1827
1938
|
criterionResults?: CriterionResult[];
|
|
1828
1939
|
/** Criterion results emitted by deep_people_search and people_scoring. */
|
|
1829
1940
|
deepCriteria?: CriterionResult[];
|
|
1941
|
+
/** Number of criteria actually judged by an LLM; zero means the candidate was unjudged. */
|
|
1942
|
+
criteriaJudged?: number;
|
|
1830
1943
|
/** Warnings about criteria that couldn't be fully verified */
|
|
1831
1944
|
criteriaQualityWarnings?: string[];
|
|
1832
1945
|
/** Explanation of LinkedIn engagement relevance (if applicable) */
|
|
@@ -1858,6 +1971,17 @@ interface ValidatedCandidate {
|
|
|
1858
1971
|
relevanceTier?: RelevanceTier;
|
|
1859
1972
|
/** One-line reranker justification grounded in candidate data. */
|
|
1860
1973
|
relevanceReason?: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* Backend-authored delivery tier. Current runs use 3 for judged/in-region,
|
|
1976
|
+
* 2 for judged/out-of-region, and 0 for unjudged. Tier 1 may exist on older responses.
|
|
1977
|
+
*/
|
|
1978
|
+
rankTier?: 0 | 1 | 2 | 3;
|
|
1979
|
+
/** Whether the candidate satisfies the search's location requirement. */
|
|
1980
|
+
geoOk?: boolean;
|
|
1981
|
+
/** Model's direct answer to the location requirement, when one exists. */
|
|
1982
|
+
llmRegionMatch?: boolean | null;
|
|
1983
|
+
/** Reasoning behind `llmRegionMatch`. */
|
|
1984
|
+
llmRegionMatchReasoning?: string | null;
|
|
1861
1985
|
/**
|
|
1862
1986
|
* Primary current operating role from the reranker (main full-time job, not side/advisory).
|
|
1863
1987
|
* Also written to `currentTitle` when present.
|
|
@@ -1873,13 +1997,12 @@ interface ValidatedCandidate {
|
|
|
1873
1997
|
enrichedCurrentCompany?: string;
|
|
1874
1998
|
/**
|
|
1875
1999
|
* True when the candidate failed at least one universal or post_hard (must-have) criterion.
|
|
1876
|
-
*
|
|
1877
|
-
* of relevance score.
|
|
2000
|
+
* This affects scoring and routing but no longer forces a lower delivery tier.
|
|
1878
2001
|
*/
|
|
1879
2002
|
anyUniversalFailed?: boolean;
|
|
1880
2003
|
/**
|
|
1881
2004
|
* True when promoted from excluded to meet the requested count despite failing hard
|
|
1882
|
-
* criteria.
|
|
2005
|
+
* criteria. This is useful for display and auditing but no longer forces a lower rank tier.
|
|
1883
2006
|
*/
|
|
1884
2007
|
backfilled?: boolean;
|
|
1885
2008
|
/**
|
|
@@ -1890,6 +2013,12 @@ interface ValidatedCandidate {
|
|
|
1890
2013
|
* competitor_post_engagement (with competitor provenance joined in).
|
|
1891
2014
|
*/
|
|
1892
2015
|
engagementData?: PostEngagementData[];
|
|
2016
|
+
/** Broader recent reaction history loaded for engagement-expansion finalists. */
|
|
2017
|
+
engagementHistory?: EngagementHistoryEntry[];
|
|
2018
|
+
/** Number of history records found while preparing a later expansion hop. */
|
|
2019
|
+
engagementHistoryCount?: number;
|
|
2020
|
+
/** True when a later hop found this person through an additional independent post. */
|
|
2021
|
+
refoundOnNewPost?: boolean;
|
|
1893
2022
|
/** Source of candidate data */
|
|
1894
2023
|
source?: string;
|
|
1895
2024
|
/** When source is job_signal: hiring-company context from CrustData job listings */
|
|
@@ -2000,12 +2129,14 @@ interface StructuredResponse extends Record<string, any> {
|
|
|
2000
2129
|
outputs?: ContentIntelligenceOutputs;
|
|
2001
2130
|
coverage?: ContentIntelligenceCoverage;
|
|
2002
2131
|
audienceStats?: ContentIntelligenceAudienceStats | Record<string, never>;
|
|
2132
|
+
/** Engagement expansion output (when using engagement_expansion agent). */
|
|
2133
|
+
expansionStats?: EngagementExpansionStats;
|
|
2003
2134
|
}
|
|
2004
2135
|
/**
|
|
2005
2136
|
* Available specialized agents
|
|
2006
2137
|
* Using a union type that can be extended with any string to support future agents
|
|
2007
2138
|
*/
|
|
2008
|
-
type SpecializedAgentType = 'quick_people_search' | 'deep_people_search' | 'people_scoring' | 'competitor_post_engagement' | 'competitor_rep_engagement' | 'content_intelligence' | (string & {});
|
|
2139
|
+
type SpecializedAgentType = 'quick_people_search' | 'deep_people_search' | 'people_scoring' | 'competitor_post_engagement' | 'competitor_rep_engagement' | 'content_intelligence' | 'engagement_expansion' | (string & {});
|
|
2009
2140
|
/**
|
|
2010
2141
|
* Shared posts date-range enum (deep_people_search, competitor_post_engagement,
|
|
2011
2142
|
* competitor_rep_engagement).
|
|
@@ -2119,6 +2250,16 @@ interface SpecializedAgentParams {
|
|
|
2119
2250
|
* Used by content_intelligence.
|
|
2120
2251
|
*/
|
|
2121
2252
|
outputs?: ContentIntelligenceOutputName[];
|
|
2253
|
+
/** Saved content-intelligence response whose package seeds the expansion. */
|
|
2254
|
+
expandFromResponse?: string;
|
|
2255
|
+
/** Outward rounds to walk. Minimum 1; defaults to 1. */
|
|
2256
|
+
hops?: number;
|
|
2257
|
+
/** Answering posts per hop. Minimum 1; omitted derives breadth from `limit`. */
|
|
2258
|
+
postsPerHop?: number;
|
|
2259
|
+
/** Highest-fit people carried into the next hop. Minimum 1; defaults to 20. */
|
|
2260
|
+
peoplePerNextHop?: number;
|
|
2261
|
+
/** LinkedIn profile URLs excluded in addition to the source package audience. */
|
|
2262
|
+
excludeUrls?: string[];
|
|
2122
2263
|
/**
|
|
2123
2264
|
* Results requested from each Exa query in the people-search research lane.
|
|
2124
2265
|
* Minimum 1; omitted uses the lane default of 100.
|
|
@@ -2517,7 +2658,7 @@ interface CreateResponseRequest {
|
|
|
2517
2658
|
* Route to a specialized agent instead of the main Lumnis agent
|
|
2518
2659
|
* Known agents: 'quick_people_search', 'deep_people_search', 'people_scoring',
|
|
2519
2660
|
* 'competitor_post_engagement', 'competitor_rep_engagement',
|
|
2520
|
-
* 'content_intelligence'
|
|
2661
|
+
* 'content_intelligence', 'engagement_expansion'
|
|
2521
2662
|
* Accepts any string to support future agents without SDK updates
|
|
2522
2663
|
*/
|
|
2523
2664
|
specializedAgent?: SpecializedAgentType;
|
|
@@ -6325,6 +6466,7 @@ declare class ResponsesResource {
|
|
|
6325
6466
|
private _validateCompetitorPostEngagementParams;
|
|
6326
6467
|
private _validateCompetitorRepEngagementParams;
|
|
6327
6468
|
private _validateContentIntelligenceParams;
|
|
6469
|
+
private _validateEngagementExpansionParams;
|
|
6328
6470
|
private _validateCriteriaParams;
|
|
6329
6471
|
private _validateFileReference;
|
|
6330
6472
|
/**
|
|
@@ -6529,6 +6671,22 @@ declare class ResponsesResource {
|
|
|
6529
6671
|
* Omit `outputs` to use the backend's default set.
|
|
6530
6672
|
*/
|
|
6531
6673
|
contentIntelligence(query: string, options?: ContentIntelligenceOptions): Promise<CreateResponseResponse>;
|
|
6674
|
+
/**
|
|
6675
|
+
* Find new people by walking outward from a saved content-intelligence package.
|
|
6676
|
+
*
|
|
6677
|
+
* Hop 1 pulls the other engagers of the package's best posts. Additional hops
|
|
6678
|
+
* select the highest-fit new people, rank posts from their feeds, and pull the
|
|
6679
|
+
* engagers of those posts. Collection breadth is derived from `limit` unless
|
|
6680
|
+
* `postsPerHop` is set explicitly. At the default limit, collection is about
|
|
6681
|
+
* 300 credits for one hop and 1,060 for three hops; enrichment and validation
|
|
6682
|
+
* use the standard deep-search economics on top.
|
|
6683
|
+
*
|
|
6684
|
+
* @param query - Persona prompt used to rank and validate discovered people.
|
|
6685
|
+
* @param options - Source response plus hop, breadth, limit, and exclusion controls.
|
|
6686
|
+
* @returns Response; poll with `get()` and read `structuredResponse` as
|
|
6687
|
+
* {@link EngagementExpansionOutput}.
|
|
6688
|
+
*/
|
|
6689
|
+
engagementExpansion(query: string, options: EngagementExpansionOptions): Promise<CreateResponseResponse>;
|
|
6532
6690
|
/**
|
|
6533
6691
|
* Score people who reacted to or commented on competitor LinkedIn posts.
|
|
6534
6692
|
*
|
|
@@ -8181,4 +8339,4 @@ declare class ProgressTracker {
|
|
|
8181
8339
|
*/
|
|
8182
8340
|
declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
|
|
8183
8341
|
|
|
8184
|
-
export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type Channel, type ChannelContactHistory, type ChannelFunnel, type ChannelRatios, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type ColumnKind, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectInboxRequest, type ConnectInboxResponse, type Connection, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsResponse, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactFinding, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, type ContentIntelligenceAudienceStats, type ContentIntelligenceAuthor, type ContentIntelligenceCoverage, type ContentIntelligenceCoveragePerson, type ContentIntelligenceCurationStats, type ContentIntelligenceDateValue, type ContentIntelligenceEngager, type ContentIntelligenceOptions, type ContentIntelligenceOutput, type ContentIntelligenceOutputName, type ContentIntelligenceOutputs, type ContentIntelligencePackage, type ContentIntelligencePost, type ContentIntelligenceResolvedParams, type ContentIntelligenceSummary, type ContentLimit, type ContentSource, type ContentType, type ConversationDetail, ConversationStatus, type ConversationSummary, type CreateDraftRequest, type CreateFeedbackRequest, type CreateFeedbackResponse, type CreateResponseRequest, type CreateResponseResponse, type CreateThreadRequest, type CriteriaClassification, type CriteriaMetadata, type CriterionDefinition, type CriterionResult, type CriterionType, type CrmContactInput, type CrmContactsSyncRequest, type CrmContactsSyncResponse, type CrmContactsSyncStatusResponse, type CrmExclusionGrantListResponse, type CrmExclusionGrantRequest, type CrmExclusionGrantResponse, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailInboxItem, type EmailInboxListResponse, type EmailInboxPersona, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, type EmailThreadSummary, type EngagementAnalysisOutput, type EngagementAnalysisScope, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, EnrichmentResource, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, type EvidenceSource, type ExecutionDetailResponse, type ExecutionEvent, type ExecutionEventData, type ExecutionListResponse, type ExecutionMetricsOptions, type ExecutionMetricsResponse, type ExecutionStatus, type ExecutionSummary, type ExecutionSummaryExtended, type ExecutionsParams, type ExecutionsRequestItem, type ExecutionsResponseItem, ExternalAPIKeysResource, type ExternalApiKeyResponse, type FeedbackListResponse, type FeedbackObject, type FeedbackType, type FileAttachment, type FileChunk, type FileContentResponse, type FileListResponse, type FileMetadata, type FileScope, type FileScopeUpdateRequest, type FileSearchRequest, type FileSearchResponse, type FileSearchResult, type FileStatisticsResponse, type FileUploadResponse, FilesResource, type FilterLogic, type FilterValue, type FunnelStage, type GetConnectionStatusParams, type GetContactRelationshipsOptions, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InboxKind, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type ListAcceptedConnectionsParams, type ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListConnectionsParams, type ListExecutionsOptions, type ListInboxesParams, type ListPendingApprovalsOptions, type ListPlaybooksOptions, type ListProvidersResponse, type ListStepExecutionsOptions, type ListTemplatesOptions, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type MailboxUpdateRequest, type MailboxUpdateResponse, type Message, type MessageReceivedData, type MessageResponse, type MessageSentData, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingResource, MessagingSendError, MessagingValidationError, type MetricsParams, type MetricsRequestItem, type MetricsResponseItem, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NetworkDistance, NoDataSourcesError, NotFoundError, type OnFailure, type Opportunity, type OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, OutreachResource, type OutreachSource, type OutreachStats, type PaginationInfo, type PaginationParams, type PainPoint, type PauseProspectsRequest, type PauseProspectsResponse, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PeriodInsight, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostIdea, type PostIdeasOutput, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RelevanceTier, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type ResumeProspectsRequest, SEQUENCE_RATE_LIMITS, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SenderPersonaInput, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type SequenceRateLimitAction, type SequenceStepCompletedData, type SequenceTemplateCreate, type SequenceTemplateResponse, type SequenceTemplateUpdate, SequencesResource, SharePermission, type SkillAnalyticsRequest, type SkillEffectivenessMetrics, type SkillGuidelineBase, type SkillGuidelineCreate, type SkillGuidelineListResponse, type SkillGuidelineResponse, type SkillGuidelineUpdate, type SkillRetrievalMetadata, type SkillUsageBase, type SkillUsageCreate, type SkillUsageListResponse, type SkillUsageResponse, type SkillUsageUpdate, SkillsResource, type SkipActionRequest, type SkipStepRequest, type SkipStepResponse, type SkippedProspect, type SkippedTransferProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type Stage, type StageFilter, type StandoutPost, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionItem, type StepExecutionListResponse, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoppedBreakdown, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, SyncPhaseStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type Takeaway, type TeardownOrgResponse, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThemeAssignment, type ThemePeriodStats, type ThemeStats, type ThemeTrend, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TopPost, type TopPostsOutput, type TopVoice, type TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
|
|
8342
|
+
export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type Channel, type ChannelContactHistory, type ChannelFunnel, type ChannelRatios, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type ColumnKind, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectInboxRequest, type ConnectInboxResponse, type Connection, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsResponse, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactFinding, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, type ContentIntelligenceAudienceStats, type ContentIntelligenceAuthor, type ContentIntelligenceCoverage, type ContentIntelligenceCoveragePerson, type ContentIntelligenceCurationStats, type ContentIntelligenceDateValue, type ContentIntelligenceEngager, type ContentIntelligenceOptions, type ContentIntelligenceOutput, type ContentIntelligenceOutputName, type ContentIntelligenceOutputs, type ContentIntelligencePackage, type ContentIntelligencePost, type ContentIntelligenceResolvedParams, type ContentIntelligenceSummary, type ContentLimit, type ContentSource, type ContentType, type ConversationDetail, ConversationStatus, type ConversationSummary, type CreateDraftRequest, type CreateFeedbackRequest, type CreateFeedbackResponse, type CreateResponseRequest, type CreateResponseResponse, type CreateThreadRequest, type CriteriaClassification, type CriteriaMetadata, type CriterionDefinition, type CriterionResult, type CriterionType, type CrmContactInput, type CrmContactsSyncRequest, type CrmContactsSyncResponse, type CrmContactsSyncStatusResponse, type CrmExclusionGrantListResponse, type CrmExclusionGrantRequest, type CrmExclusionGrantResponse, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailInboxItem, type EmailInboxListResponse, type EmailInboxPersona, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, type EmailThreadSummary, type EngagementAnalysisOutput, type EngagementAnalysisScope, type EngagementExpansionHopStats, type EngagementExpansionOptions, type EngagementExpansionOutput, type EngagementExpansionResolvedParams, type EngagementExpansionStats, type EngagementHistoryEntry, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, EnrichmentResource, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, type EvidenceSource, type ExecutionDetailResponse, type ExecutionEvent, type ExecutionEventData, type ExecutionListResponse, type ExecutionMetricsOptions, type ExecutionMetricsResponse, type ExecutionStatus, type ExecutionSummary, type ExecutionSummaryExtended, type ExecutionsParams, type ExecutionsRequestItem, type ExecutionsResponseItem, ExternalAPIKeysResource, type ExternalApiKeyResponse, type FeedbackListResponse, type FeedbackObject, type FeedbackType, type FileAttachment, type FileChunk, type FileContentResponse, type FileListResponse, type FileMetadata, type FileScope, type FileScopeUpdateRequest, type FileSearchRequest, type FileSearchResponse, type FileSearchResult, type FileStatisticsResponse, type FileUploadResponse, FilesResource, type FilterLogic, type FilterValue, type FunnelStage, type GetConnectionStatusParams, type GetContactRelationshipsOptions, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InboxKind, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type ListAcceptedConnectionsParams, type ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListConnectionsParams, type ListExecutionsOptions, type ListInboxesParams, type ListPendingApprovalsOptions, type ListPlaybooksOptions, type ListProvidersResponse, type ListStepExecutionsOptions, type ListTemplatesOptions, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type MailboxUpdateRequest, type MailboxUpdateResponse, type Message, type MessageReceivedData, type MessageResponse, type MessageSentData, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingResource, MessagingSendError, MessagingValidationError, type MetricsParams, type MetricsRequestItem, type MetricsResponseItem, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NetworkDistance, NoDataSourcesError, NotFoundError, type OnFailure, type Opportunity, type OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, OutreachResource, type OutreachSource, type OutreachStats, type PaginationInfo, type PaginationParams, type PainPoint, type PauseProspectsRequest, type PauseProspectsResponse, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PeriodInsight, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostIdea, type PostIdeasOutput, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RelevanceTier, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type ResumeProspectsRequest, SEQUENCE_RATE_LIMITS, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SenderPersonaInput, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type SequenceRateLimitAction, type SequenceStepCompletedData, type SequenceTemplateCreate, type SequenceTemplateResponse, type SequenceTemplateUpdate, SequencesResource, SharePermission, type SkillAnalyticsRequest, type SkillEffectivenessMetrics, type SkillGuidelineBase, type SkillGuidelineCreate, type SkillGuidelineListResponse, type SkillGuidelineResponse, type SkillGuidelineUpdate, type SkillRetrievalMetadata, type SkillUsageBase, type SkillUsageCreate, type SkillUsageListResponse, type SkillUsageResponse, type SkillUsageUpdate, SkillsResource, type SkipActionRequest, type SkipStepRequest, type SkipStepResponse, type SkippedProspect, type SkippedTransferProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type Stage, type StageFilter, type StandoutPost, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionItem, type StepExecutionListResponse, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoppedBreakdown, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, SyncPhaseStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type Takeaway, type TeardownOrgResponse, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThemeAssignment, type ThemePeriodStats, type ThemeStats, type ThemeTrend, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TopPost, type TopPostsOutput, type TopVoice, type TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
|
package/dist/index.d.mts
CHANGED
|
@@ -836,8 +836,17 @@ interface ResolvedCompetitorTarget {
|
|
|
836
836
|
* provenance (competitor, author, date). Multiple posts → multiple entries.
|
|
837
837
|
*/
|
|
838
838
|
interface PostEngagementData {
|
|
839
|
+
/** Stable package key for the source post (engagement expansion). */
|
|
840
|
+
postKey?: string;
|
|
839
841
|
/** LinkedIn post URL the person engaged with */
|
|
840
842
|
postUrl: string;
|
|
843
|
+
/** Full source-post text when retained by the lane. */
|
|
844
|
+
postText?: string | null;
|
|
845
|
+
/** Source-post publication date; reaction payloads do not provide per-person timestamps. */
|
|
846
|
+
postPublished?: string | {
|
|
847
|
+
kind?: string;
|
|
848
|
+
value?: string;
|
|
849
|
+
} | null;
|
|
841
850
|
/** How the person engaged */
|
|
842
851
|
role: 'reactor' | 'commenter';
|
|
843
852
|
/** Reaction type for reactors (e.g. LIKE, PRAISE, EMPATHY) */
|
|
@@ -850,12 +859,22 @@ interface PostEngagementData {
|
|
|
850
859
|
postAuthorType?: 'company' | 'exec';
|
|
851
860
|
/** Name of the post author (company or exec) */
|
|
852
861
|
postAuthorName?: string;
|
|
862
|
+
/** Source-post author name used by engagement expansion. */
|
|
863
|
+
postAuthor?: string;
|
|
853
864
|
/** LinkedIn URL of the post author */
|
|
854
865
|
postAuthorUrl?: string;
|
|
855
866
|
/** ISO timestamp of the post */
|
|
856
867
|
postDate?: string;
|
|
857
868
|
/** Total engagement on the post (reactions + comments) at selection time */
|
|
858
869
|
engagementScore?: number;
|
|
870
|
+
/** One-based expansion hop that discovered this edge. */
|
|
871
|
+
hop?: number;
|
|
872
|
+
/** Expansion walk strategy that produced the edge. */
|
|
873
|
+
walk?: 'post_coengagement' | string;
|
|
874
|
+
/** Relevance assigned to the source post during curation. */
|
|
875
|
+
postRelevance?: number | null;
|
|
876
|
+
/** Source-package audience members who also engaged with this post. */
|
|
877
|
+
audienceEngagers?: string[];
|
|
859
878
|
[key: string]: any;
|
|
860
879
|
}
|
|
861
880
|
/** @deprecated Use {@link PostEngagementData} */
|
|
@@ -1165,6 +1184,8 @@ interface ContentIntelligencePost {
|
|
|
1165
1184
|
relevance?: number | null;
|
|
1166
1185
|
totalReactions?: number | null;
|
|
1167
1186
|
totalComments?: number | null;
|
|
1187
|
+
/** Whether the source post includes video. The backend does not expose the media URL. */
|
|
1188
|
+
hasVideo?: boolean;
|
|
1168
1189
|
hybridScore?: number;
|
|
1169
1190
|
}
|
|
1170
1191
|
interface ContentIntelligencePackage {
|
|
@@ -1193,6 +1214,12 @@ interface PostIdea {
|
|
|
1193
1214
|
idea: string;
|
|
1194
1215
|
angle: string;
|
|
1195
1216
|
citedPostKeys: string[];
|
|
1217
|
+
/** Clickable source posts that inspired the idea. */
|
|
1218
|
+
citedPosts: Array<{
|
|
1219
|
+
key: string;
|
|
1220
|
+
url?: string | null;
|
|
1221
|
+
author?: string | null;
|
|
1222
|
+
}>;
|
|
1196
1223
|
draft: string;
|
|
1197
1224
|
probability: number;
|
|
1198
1225
|
keysExist: number;
|
|
@@ -1387,6 +1414,84 @@ interface ContentIntelligenceOutput {
|
|
|
1387
1414
|
agentParams: ContentIntelligenceResolvedParams;
|
|
1388
1415
|
}
|
|
1389
1416
|
|
|
1417
|
+
/** Options accepted by {@link ResponsesResource.engagementExpansion}. */
|
|
1418
|
+
interface EngagementExpansionOptions {
|
|
1419
|
+
/** Finished content_intelligence response whose saved package seeds the walk. */
|
|
1420
|
+
expandFromResponse: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* Number of outward rounds to run. At the default limit, collection is
|
|
1423
|
+
* approximately 300 credits for one hop and 1,060 for three hops.
|
|
1424
|
+
* Enrichment and validation are additional. @default 1
|
|
1425
|
+
*/
|
|
1426
|
+
hops?: number;
|
|
1427
|
+
/**
|
|
1428
|
+
* Answering posts to collect per hop at 5 credits each. Omit to derive
|
|
1429
|
+
* breadth from `limit`: limits 25 or 50 derive 60 posts (300 credits),
|
|
1430
|
+
* while limit 200 derives 240 posts (1,200 credits).
|
|
1431
|
+
*/
|
|
1432
|
+
postsPerHop?: number;
|
|
1433
|
+
/** Highest-fit people whose feeds seed the next hop. Ignored for one hop. @default 20 */
|
|
1434
|
+
peoplePerNextHop?: number;
|
|
1435
|
+
/** Maximum validated people returned. @default 50 */
|
|
1436
|
+
limit?: number;
|
|
1437
|
+
/** LinkedIn profile URLs excluded in addition to the source package's audience. */
|
|
1438
|
+
excludeUrls?: string[];
|
|
1439
|
+
/** SLM relevance reranker for surfaced candidates. @default true */
|
|
1440
|
+
deepValidationUseRelevanceReranker?: boolean;
|
|
1441
|
+
}
|
|
1442
|
+
/** Resolved parameters echoed in `structuredResponse.agentParams`. */
|
|
1443
|
+
interface EngagementExpansionResolvedParams {
|
|
1444
|
+
expandFromResponse: string;
|
|
1445
|
+
hops: number;
|
|
1446
|
+
postsPerHop?: number | null;
|
|
1447
|
+
peoplePerNextHop: number;
|
|
1448
|
+
limit: number;
|
|
1449
|
+
excludeUrls?: string[] | null;
|
|
1450
|
+
}
|
|
1451
|
+
/** Collection statistics for one expansion hop. */
|
|
1452
|
+
interface EngagementExpansionHopStats {
|
|
1453
|
+
hop: number;
|
|
1454
|
+
postsPulled: number;
|
|
1455
|
+
newPeople: number;
|
|
1456
|
+
refinds: number;
|
|
1457
|
+
refindsMergedAsNewEdges: number;
|
|
1458
|
+
authorColleaguesExcluded: number;
|
|
1459
|
+
credits: number;
|
|
1460
|
+
stopReason: string;
|
|
1461
|
+
}
|
|
1462
|
+
/** Collection and finalist-history accounting for an expansion run. */
|
|
1463
|
+
interface EngagementExpansionStats {
|
|
1464
|
+
hopsRun: number;
|
|
1465
|
+
hopsRequested: number;
|
|
1466
|
+
postsPerHop: number;
|
|
1467
|
+
postsPerHopSource: 'requested' | 'derived';
|
|
1468
|
+
/** Hop collection only; enrichment and validation use standard deep-search economics. */
|
|
1469
|
+
collectionCreditsSpent: number;
|
|
1470
|
+
collectionCreditCeiling: number;
|
|
1471
|
+
stopReason: string;
|
|
1472
|
+
perHop: EngagementExpansionHopStats[];
|
|
1473
|
+
/** Credits spent loading broader engagement history for finalists. */
|
|
1474
|
+
finalistHistoryCredits?: number;
|
|
1475
|
+
/** Finalists for whom broader engagement history was available. */
|
|
1476
|
+
finalistsWithHistory?: number;
|
|
1477
|
+
}
|
|
1478
|
+
/** A recent LinkedIn reaction used to give validation broader behavioral context. */
|
|
1479
|
+
interface EngagementHistoryEntry {
|
|
1480
|
+
when?: string | null;
|
|
1481
|
+
reactionType?: string | null;
|
|
1482
|
+
postAuthor?: string | null;
|
|
1483
|
+
postUrl?: string | null;
|
|
1484
|
+
postText?: string | null;
|
|
1485
|
+
}
|
|
1486
|
+
/** Full structured output from a succeeded `engagement_expansion` run. */
|
|
1487
|
+
interface EngagementExpansionOutput {
|
|
1488
|
+
/** Validated candidates, preserving the backend's scoring order and capped to `limit`. */
|
|
1489
|
+
candidates: ValidatedCandidate[];
|
|
1490
|
+
criteria?: CriteriaMetadata;
|
|
1491
|
+
expansionStats?: EngagementExpansionStats;
|
|
1492
|
+
agentParams: EngagementExpansionResolvedParams;
|
|
1493
|
+
}
|
|
1494
|
+
|
|
1390
1495
|
/**
|
|
1391
1496
|
* Available people search data sources
|
|
1392
1497
|
*/
|
|
@@ -1815,6 +1920,12 @@ interface ValidatedCandidate {
|
|
|
1815
1920
|
currentCompany?: string;
|
|
1816
1921
|
/** Location */
|
|
1817
1922
|
location?: string;
|
|
1923
|
+
/** Location resolved by validation, including an evidence-based inference when needed. */
|
|
1924
|
+
primaryLocation?: string | null;
|
|
1925
|
+
/** Evidence and reasoning used to resolve `primaryLocation`. */
|
|
1926
|
+
locationReasoning?: string | null;
|
|
1927
|
+
/** Provenance for an inferred `location`, such as `inferred:validation`. */
|
|
1928
|
+
locationSource?: string | null;
|
|
1818
1929
|
/** Profile picture URL */
|
|
1819
1930
|
profilePictureUrl?: string;
|
|
1820
1931
|
/** Overall match score (0-10) */
|
|
@@ -1827,6 +1938,8 @@ interface ValidatedCandidate {
|
|
|
1827
1938
|
criterionResults?: CriterionResult[];
|
|
1828
1939
|
/** Criterion results emitted by deep_people_search and people_scoring. */
|
|
1829
1940
|
deepCriteria?: CriterionResult[];
|
|
1941
|
+
/** Number of criteria actually judged by an LLM; zero means the candidate was unjudged. */
|
|
1942
|
+
criteriaJudged?: number;
|
|
1830
1943
|
/** Warnings about criteria that couldn't be fully verified */
|
|
1831
1944
|
criteriaQualityWarnings?: string[];
|
|
1832
1945
|
/** Explanation of LinkedIn engagement relevance (if applicable) */
|
|
@@ -1858,6 +1971,17 @@ interface ValidatedCandidate {
|
|
|
1858
1971
|
relevanceTier?: RelevanceTier;
|
|
1859
1972
|
/** One-line reranker justification grounded in candidate data. */
|
|
1860
1973
|
relevanceReason?: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* Backend-authored delivery tier. Current runs use 3 for judged/in-region,
|
|
1976
|
+
* 2 for judged/out-of-region, and 0 for unjudged. Tier 1 may exist on older responses.
|
|
1977
|
+
*/
|
|
1978
|
+
rankTier?: 0 | 1 | 2 | 3;
|
|
1979
|
+
/** Whether the candidate satisfies the search's location requirement. */
|
|
1980
|
+
geoOk?: boolean;
|
|
1981
|
+
/** Model's direct answer to the location requirement, when one exists. */
|
|
1982
|
+
llmRegionMatch?: boolean | null;
|
|
1983
|
+
/** Reasoning behind `llmRegionMatch`. */
|
|
1984
|
+
llmRegionMatchReasoning?: string | null;
|
|
1861
1985
|
/**
|
|
1862
1986
|
* Primary current operating role from the reranker (main full-time job, not side/advisory).
|
|
1863
1987
|
* Also written to `currentTitle` when present.
|
|
@@ -1873,13 +1997,12 @@ interface ValidatedCandidate {
|
|
|
1873
1997
|
enrichedCurrentCompany?: string;
|
|
1874
1998
|
/**
|
|
1875
1999
|
* True when the candidate failed at least one universal or post_hard (must-have) criterion.
|
|
1876
|
-
*
|
|
1877
|
-
* of relevance score.
|
|
2000
|
+
* This affects scoring and routing but no longer forces a lower delivery tier.
|
|
1878
2001
|
*/
|
|
1879
2002
|
anyUniversalFailed?: boolean;
|
|
1880
2003
|
/**
|
|
1881
2004
|
* True when promoted from excluded to meet the requested count despite failing hard
|
|
1882
|
-
* criteria.
|
|
2005
|
+
* criteria. This is useful for display and auditing but no longer forces a lower rank tier.
|
|
1883
2006
|
*/
|
|
1884
2007
|
backfilled?: boolean;
|
|
1885
2008
|
/**
|
|
@@ -1890,6 +2013,12 @@ interface ValidatedCandidate {
|
|
|
1890
2013
|
* competitor_post_engagement (with competitor provenance joined in).
|
|
1891
2014
|
*/
|
|
1892
2015
|
engagementData?: PostEngagementData[];
|
|
2016
|
+
/** Broader recent reaction history loaded for engagement-expansion finalists. */
|
|
2017
|
+
engagementHistory?: EngagementHistoryEntry[];
|
|
2018
|
+
/** Number of history records found while preparing a later expansion hop. */
|
|
2019
|
+
engagementHistoryCount?: number;
|
|
2020
|
+
/** True when a later hop found this person through an additional independent post. */
|
|
2021
|
+
refoundOnNewPost?: boolean;
|
|
1893
2022
|
/** Source of candidate data */
|
|
1894
2023
|
source?: string;
|
|
1895
2024
|
/** When source is job_signal: hiring-company context from CrustData job listings */
|
|
@@ -2000,12 +2129,14 @@ interface StructuredResponse extends Record<string, any> {
|
|
|
2000
2129
|
outputs?: ContentIntelligenceOutputs;
|
|
2001
2130
|
coverage?: ContentIntelligenceCoverage;
|
|
2002
2131
|
audienceStats?: ContentIntelligenceAudienceStats | Record<string, never>;
|
|
2132
|
+
/** Engagement expansion output (when using engagement_expansion agent). */
|
|
2133
|
+
expansionStats?: EngagementExpansionStats;
|
|
2003
2134
|
}
|
|
2004
2135
|
/**
|
|
2005
2136
|
* Available specialized agents
|
|
2006
2137
|
* Using a union type that can be extended with any string to support future agents
|
|
2007
2138
|
*/
|
|
2008
|
-
type SpecializedAgentType = 'quick_people_search' | 'deep_people_search' | 'people_scoring' | 'competitor_post_engagement' | 'competitor_rep_engagement' | 'content_intelligence' | (string & {});
|
|
2139
|
+
type SpecializedAgentType = 'quick_people_search' | 'deep_people_search' | 'people_scoring' | 'competitor_post_engagement' | 'competitor_rep_engagement' | 'content_intelligence' | 'engagement_expansion' | (string & {});
|
|
2009
2140
|
/**
|
|
2010
2141
|
* Shared posts date-range enum (deep_people_search, competitor_post_engagement,
|
|
2011
2142
|
* competitor_rep_engagement).
|
|
@@ -2119,6 +2250,16 @@ interface SpecializedAgentParams {
|
|
|
2119
2250
|
* Used by content_intelligence.
|
|
2120
2251
|
*/
|
|
2121
2252
|
outputs?: ContentIntelligenceOutputName[];
|
|
2253
|
+
/** Saved content-intelligence response whose package seeds the expansion. */
|
|
2254
|
+
expandFromResponse?: string;
|
|
2255
|
+
/** Outward rounds to walk. Minimum 1; defaults to 1. */
|
|
2256
|
+
hops?: number;
|
|
2257
|
+
/** Answering posts per hop. Minimum 1; omitted derives breadth from `limit`. */
|
|
2258
|
+
postsPerHop?: number;
|
|
2259
|
+
/** Highest-fit people carried into the next hop. Minimum 1; defaults to 20. */
|
|
2260
|
+
peoplePerNextHop?: number;
|
|
2261
|
+
/** LinkedIn profile URLs excluded in addition to the source package audience. */
|
|
2262
|
+
excludeUrls?: string[];
|
|
2122
2263
|
/**
|
|
2123
2264
|
* Results requested from each Exa query in the people-search research lane.
|
|
2124
2265
|
* Minimum 1; omitted uses the lane default of 100.
|
|
@@ -2517,7 +2658,7 @@ interface CreateResponseRequest {
|
|
|
2517
2658
|
* Route to a specialized agent instead of the main Lumnis agent
|
|
2518
2659
|
* Known agents: 'quick_people_search', 'deep_people_search', 'people_scoring',
|
|
2519
2660
|
* 'competitor_post_engagement', 'competitor_rep_engagement',
|
|
2520
|
-
* 'content_intelligence'
|
|
2661
|
+
* 'content_intelligence', 'engagement_expansion'
|
|
2521
2662
|
* Accepts any string to support future agents without SDK updates
|
|
2522
2663
|
*/
|
|
2523
2664
|
specializedAgent?: SpecializedAgentType;
|
|
@@ -6325,6 +6466,7 @@ declare class ResponsesResource {
|
|
|
6325
6466
|
private _validateCompetitorPostEngagementParams;
|
|
6326
6467
|
private _validateCompetitorRepEngagementParams;
|
|
6327
6468
|
private _validateContentIntelligenceParams;
|
|
6469
|
+
private _validateEngagementExpansionParams;
|
|
6328
6470
|
private _validateCriteriaParams;
|
|
6329
6471
|
private _validateFileReference;
|
|
6330
6472
|
/**
|
|
@@ -6529,6 +6671,22 @@ declare class ResponsesResource {
|
|
|
6529
6671
|
* Omit `outputs` to use the backend's default set.
|
|
6530
6672
|
*/
|
|
6531
6673
|
contentIntelligence(query: string, options?: ContentIntelligenceOptions): Promise<CreateResponseResponse>;
|
|
6674
|
+
/**
|
|
6675
|
+
* Find new people by walking outward from a saved content-intelligence package.
|
|
6676
|
+
*
|
|
6677
|
+
* Hop 1 pulls the other engagers of the package's best posts. Additional hops
|
|
6678
|
+
* select the highest-fit new people, rank posts from their feeds, and pull the
|
|
6679
|
+
* engagers of those posts. Collection breadth is derived from `limit` unless
|
|
6680
|
+
* `postsPerHop` is set explicitly. At the default limit, collection is about
|
|
6681
|
+
* 300 credits for one hop and 1,060 for three hops; enrichment and validation
|
|
6682
|
+
* use the standard deep-search economics on top.
|
|
6683
|
+
*
|
|
6684
|
+
* @param query - Persona prompt used to rank and validate discovered people.
|
|
6685
|
+
* @param options - Source response plus hop, breadth, limit, and exclusion controls.
|
|
6686
|
+
* @returns Response; poll with `get()` and read `structuredResponse` as
|
|
6687
|
+
* {@link EngagementExpansionOutput}.
|
|
6688
|
+
*/
|
|
6689
|
+
engagementExpansion(query: string, options: EngagementExpansionOptions): Promise<CreateResponseResponse>;
|
|
6532
6690
|
/**
|
|
6533
6691
|
* Score people who reacted to or commented on competitor LinkedIn posts.
|
|
6534
6692
|
*
|
|
@@ -8181,4 +8339,4 @@ declare class ProgressTracker {
|
|
|
8181
8339
|
*/
|
|
8182
8340
|
declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
|
|
8183
8341
|
|
|
8184
|
-
export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type Channel, type ChannelContactHistory, type ChannelFunnel, type ChannelRatios, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type ColumnKind, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectInboxRequest, type ConnectInboxResponse, type Connection, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsResponse, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactFinding, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, type ContentIntelligenceAudienceStats, type ContentIntelligenceAuthor, type ContentIntelligenceCoverage, type ContentIntelligenceCoveragePerson, type ContentIntelligenceCurationStats, type ContentIntelligenceDateValue, type ContentIntelligenceEngager, type ContentIntelligenceOptions, type ContentIntelligenceOutput, type ContentIntelligenceOutputName, type ContentIntelligenceOutputs, type ContentIntelligencePackage, type ContentIntelligencePost, type ContentIntelligenceResolvedParams, type ContentIntelligenceSummary, type ContentLimit, type ContentSource, type ContentType, type ConversationDetail, ConversationStatus, type ConversationSummary, type CreateDraftRequest, type CreateFeedbackRequest, type CreateFeedbackResponse, type CreateResponseRequest, type CreateResponseResponse, type CreateThreadRequest, type CriteriaClassification, type CriteriaMetadata, type CriterionDefinition, type CriterionResult, type CriterionType, type CrmContactInput, type CrmContactsSyncRequest, type CrmContactsSyncResponse, type CrmContactsSyncStatusResponse, type CrmExclusionGrantListResponse, type CrmExclusionGrantRequest, type CrmExclusionGrantResponse, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailInboxItem, type EmailInboxListResponse, type EmailInboxPersona, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, type EmailThreadSummary, type EngagementAnalysisOutput, type EngagementAnalysisScope, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, EnrichmentResource, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, type EvidenceSource, type ExecutionDetailResponse, type ExecutionEvent, type ExecutionEventData, type ExecutionListResponse, type ExecutionMetricsOptions, type ExecutionMetricsResponse, type ExecutionStatus, type ExecutionSummary, type ExecutionSummaryExtended, type ExecutionsParams, type ExecutionsRequestItem, type ExecutionsResponseItem, ExternalAPIKeysResource, type ExternalApiKeyResponse, type FeedbackListResponse, type FeedbackObject, type FeedbackType, type FileAttachment, type FileChunk, type FileContentResponse, type FileListResponse, type FileMetadata, type FileScope, type FileScopeUpdateRequest, type FileSearchRequest, type FileSearchResponse, type FileSearchResult, type FileStatisticsResponse, type FileUploadResponse, FilesResource, type FilterLogic, type FilterValue, type FunnelStage, type GetConnectionStatusParams, type GetContactRelationshipsOptions, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InboxKind, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type ListAcceptedConnectionsParams, type ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListConnectionsParams, type ListExecutionsOptions, type ListInboxesParams, type ListPendingApprovalsOptions, type ListPlaybooksOptions, type ListProvidersResponse, type ListStepExecutionsOptions, type ListTemplatesOptions, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type MailboxUpdateRequest, type MailboxUpdateResponse, type Message, type MessageReceivedData, type MessageResponse, type MessageSentData, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingResource, MessagingSendError, MessagingValidationError, type MetricsParams, type MetricsRequestItem, type MetricsResponseItem, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NetworkDistance, NoDataSourcesError, NotFoundError, type OnFailure, type Opportunity, type OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, OutreachResource, type OutreachSource, type OutreachStats, type PaginationInfo, type PaginationParams, type PainPoint, type PauseProspectsRequest, type PauseProspectsResponse, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PeriodInsight, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostIdea, type PostIdeasOutput, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RelevanceTier, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type ResumeProspectsRequest, SEQUENCE_RATE_LIMITS, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SenderPersonaInput, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type SequenceRateLimitAction, type SequenceStepCompletedData, type SequenceTemplateCreate, type SequenceTemplateResponse, type SequenceTemplateUpdate, SequencesResource, SharePermission, type SkillAnalyticsRequest, type SkillEffectivenessMetrics, type SkillGuidelineBase, type SkillGuidelineCreate, type SkillGuidelineListResponse, type SkillGuidelineResponse, type SkillGuidelineUpdate, type SkillRetrievalMetadata, type SkillUsageBase, type SkillUsageCreate, type SkillUsageListResponse, type SkillUsageResponse, type SkillUsageUpdate, SkillsResource, type SkipActionRequest, type SkipStepRequest, type SkipStepResponse, type SkippedProspect, type SkippedTransferProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type Stage, type StageFilter, type StandoutPost, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionItem, type StepExecutionListResponse, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoppedBreakdown, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, SyncPhaseStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type Takeaway, type TeardownOrgResponse, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThemeAssignment, type ThemePeriodStats, type ThemeStats, type ThemeTrend, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TopPost, type TopPostsOutput, type TopVoice, type TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
|
|
8342
|
+
export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type Channel, type ChannelContactHistory, type ChannelFunnel, type ChannelRatios, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type ColumnKind, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectInboxRequest, type ConnectInboxResponse, type Connection, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsResponse, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactFinding, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, type ContentIntelligenceAudienceStats, type ContentIntelligenceAuthor, type ContentIntelligenceCoverage, type ContentIntelligenceCoveragePerson, type ContentIntelligenceCurationStats, type ContentIntelligenceDateValue, type ContentIntelligenceEngager, type ContentIntelligenceOptions, type ContentIntelligenceOutput, type ContentIntelligenceOutputName, type ContentIntelligenceOutputs, type ContentIntelligencePackage, type ContentIntelligencePost, type ContentIntelligenceResolvedParams, type ContentIntelligenceSummary, type ContentLimit, type ContentSource, type ContentType, type ConversationDetail, ConversationStatus, type ConversationSummary, type CreateDraftRequest, type CreateFeedbackRequest, type CreateFeedbackResponse, type CreateResponseRequest, type CreateResponseResponse, type CreateThreadRequest, type CriteriaClassification, type CriteriaMetadata, type CriterionDefinition, type CriterionResult, type CriterionType, type CrmContactInput, type CrmContactsSyncRequest, type CrmContactsSyncResponse, type CrmContactsSyncStatusResponse, type CrmExclusionGrantListResponse, type CrmExclusionGrantRequest, type CrmExclusionGrantResponse, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailInboxItem, type EmailInboxListResponse, type EmailInboxPersona, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, type EmailThreadSummary, type EngagementAnalysisOutput, type EngagementAnalysisScope, type EngagementExpansionHopStats, type EngagementExpansionOptions, type EngagementExpansionOutput, type EngagementExpansionResolvedParams, type EngagementExpansionStats, type EngagementHistoryEntry, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, EnrichmentResource, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, type EvidenceSource, type ExecutionDetailResponse, type ExecutionEvent, type ExecutionEventData, type ExecutionListResponse, type ExecutionMetricsOptions, type ExecutionMetricsResponse, type ExecutionStatus, type ExecutionSummary, type ExecutionSummaryExtended, type ExecutionsParams, type ExecutionsRequestItem, type ExecutionsResponseItem, ExternalAPIKeysResource, type ExternalApiKeyResponse, type FeedbackListResponse, type FeedbackObject, type FeedbackType, type FileAttachment, type FileChunk, type FileContentResponse, type FileListResponse, type FileMetadata, type FileScope, type FileScopeUpdateRequest, type FileSearchRequest, type FileSearchResponse, type FileSearchResult, type FileStatisticsResponse, type FileUploadResponse, FilesResource, type FilterLogic, type FilterValue, type FunnelStage, type GetConnectionStatusParams, type GetContactRelationshipsOptions, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InboxKind, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type ListAcceptedConnectionsParams, type ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListConnectionsParams, type ListExecutionsOptions, type ListInboxesParams, type ListPendingApprovalsOptions, type ListPlaybooksOptions, type ListProvidersResponse, type ListStepExecutionsOptions, type ListTemplatesOptions, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type MailboxUpdateRequest, type MailboxUpdateResponse, type Message, type MessageReceivedData, type MessageResponse, type MessageSentData, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingResource, MessagingSendError, MessagingValidationError, type MetricsParams, type MetricsRequestItem, type MetricsResponseItem, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NetworkDistance, NoDataSourcesError, NotFoundError, type OnFailure, type Opportunity, type OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, OutreachResource, type OutreachSource, type OutreachStats, type PaginationInfo, type PaginationParams, type PainPoint, type PauseProspectsRequest, type PauseProspectsResponse, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PeriodInsight, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostIdea, type PostIdeasOutput, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RelevanceTier, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type ResumeProspectsRequest, SEQUENCE_RATE_LIMITS, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SenderPersonaInput, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type SequenceRateLimitAction, type SequenceStepCompletedData, type SequenceTemplateCreate, type SequenceTemplateResponse, type SequenceTemplateUpdate, SequencesResource, SharePermission, type SkillAnalyticsRequest, type SkillEffectivenessMetrics, type SkillGuidelineBase, type SkillGuidelineCreate, type SkillGuidelineListResponse, type SkillGuidelineResponse, type SkillGuidelineUpdate, type SkillRetrievalMetadata, type SkillUsageBase, type SkillUsageCreate, type SkillUsageListResponse, type SkillUsageResponse, type SkillUsageUpdate, SkillsResource, type SkipActionRequest, type SkipStepRequest, type SkipStepResponse, type SkippedProspect, type SkippedTransferProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type Stage, type StageFilter, type StandoutPost, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionItem, type StepExecutionListResponse, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoppedBreakdown, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, SyncPhaseStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type Takeaway, type TeardownOrgResponse, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThemeAssignment, type ThemePeriodStats, type ThemeStats, type ThemeTrend, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TopPost, type TopPostsOutput, type TopVoice, type TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
|
package/dist/index.d.ts
CHANGED
|
@@ -836,8 +836,17 @@ interface ResolvedCompetitorTarget {
|
|
|
836
836
|
* provenance (competitor, author, date). Multiple posts → multiple entries.
|
|
837
837
|
*/
|
|
838
838
|
interface PostEngagementData {
|
|
839
|
+
/** Stable package key for the source post (engagement expansion). */
|
|
840
|
+
postKey?: string;
|
|
839
841
|
/** LinkedIn post URL the person engaged with */
|
|
840
842
|
postUrl: string;
|
|
843
|
+
/** Full source-post text when retained by the lane. */
|
|
844
|
+
postText?: string | null;
|
|
845
|
+
/** Source-post publication date; reaction payloads do not provide per-person timestamps. */
|
|
846
|
+
postPublished?: string | {
|
|
847
|
+
kind?: string;
|
|
848
|
+
value?: string;
|
|
849
|
+
} | null;
|
|
841
850
|
/** How the person engaged */
|
|
842
851
|
role: 'reactor' | 'commenter';
|
|
843
852
|
/** Reaction type for reactors (e.g. LIKE, PRAISE, EMPATHY) */
|
|
@@ -850,12 +859,22 @@ interface PostEngagementData {
|
|
|
850
859
|
postAuthorType?: 'company' | 'exec';
|
|
851
860
|
/** Name of the post author (company or exec) */
|
|
852
861
|
postAuthorName?: string;
|
|
862
|
+
/** Source-post author name used by engagement expansion. */
|
|
863
|
+
postAuthor?: string;
|
|
853
864
|
/** LinkedIn URL of the post author */
|
|
854
865
|
postAuthorUrl?: string;
|
|
855
866
|
/** ISO timestamp of the post */
|
|
856
867
|
postDate?: string;
|
|
857
868
|
/** Total engagement on the post (reactions + comments) at selection time */
|
|
858
869
|
engagementScore?: number;
|
|
870
|
+
/** One-based expansion hop that discovered this edge. */
|
|
871
|
+
hop?: number;
|
|
872
|
+
/** Expansion walk strategy that produced the edge. */
|
|
873
|
+
walk?: 'post_coengagement' | string;
|
|
874
|
+
/** Relevance assigned to the source post during curation. */
|
|
875
|
+
postRelevance?: number | null;
|
|
876
|
+
/** Source-package audience members who also engaged with this post. */
|
|
877
|
+
audienceEngagers?: string[];
|
|
859
878
|
[key: string]: any;
|
|
860
879
|
}
|
|
861
880
|
/** @deprecated Use {@link PostEngagementData} */
|
|
@@ -1165,6 +1184,8 @@ interface ContentIntelligencePost {
|
|
|
1165
1184
|
relevance?: number | null;
|
|
1166
1185
|
totalReactions?: number | null;
|
|
1167
1186
|
totalComments?: number | null;
|
|
1187
|
+
/** Whether the source post includes video. The backend does not expose the media URL. */
|
|
1188
|
+
hasVideo?: boolean;
|
|
1168
1189
|
hybridScore?: number;
|
|
1169
1190
|
}
|
|
1170
1191
|
interface ContentIntelligencePackage {
|
|
@@ -1193,6 +1214,12 @@ interface PostIdea {
|
|
|
1193
1214
|
idea: string;
|
|
1194
1215
|
angle: string;
|
|
1195
1216
|
citedPostKeys: string[];
|
|
1217
|
+
/** Clickable source posts that inspired the idea. */
|
|
1218
|
+
citedPosts: Array<{
|
|
1219
|
+
key: string;
|
|
1220
|
+
url?: string | null;
|
|
1221
|
+
author?: string | null;
|
|
1222
|
+
}>;
|
|
1196
1223
|
draft: string;
|
|
1197
1224
|
probability: number;
|
|
1198
1225
|
keysExist: number;
|
|
@@ -1387,6 +1414,84 @@ interface ContentIntelligenceOutput {
|
|
|
1387
1414
|
agentParams: ContentIntelligenceResolvedParams;
|
|
1388
1415
|
}
|
|
1389
1416
|
|
|
1417
|
+
/** Options accepted by {@link ResponsesResource.engagementExpansion}. */
|
|
1418
|
+
interface EngagementExpansionOptions {
|
|
1419
|
+
/** Finished content_intelligence response whose saved package seeds the walk. */
|
|
1420
|
+
expandFromResponse: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* Number of outward rounds to run. At the default limit, collection is
|
|
1423
|
+
* approximately 300 credits for one hop and 1,060 for three hops.
|
|
1424
|
+
* Enrichment and validation are additional. @default 1
|
|
1425
|
+
*/
|
|
1426
|
+
hops?: number;
|
|
1427
|
+
/**
|
|
1428
|
+
* Answering posts to collect per hop at 5 credits each. Omit to derive
|
|
1429
|
+
* breadth from `limit`: limits 25 or 50 derive 60 posts (300 credits),
|
|
1430
|
+
* while limit 200 derives 240 posts (1,200 credits).
|
|
1431
|
+
*/
|
|
1432
|
+
postsPerHop?: number;
|
|
1433
|
+
/** Highest-fit people whose feeds seed the next hop. Ignored for one hop. @default 20 */
|
|
1434
|
+
peoplePerNextHop?: number;
|
|
1435
|
+
/** Maximum validated people returned. @default 50 */
|
|
1436
|
+
limit?: number;
|
|
1437
|
+
/** LinkedIn profile URLs excluded in addition to the source package's audience. */
|
|
1438
|
+
excludeUrls?: string[];
|
|
1439
|
+
/** SLM relevance reranker for surfaced candidates. @default true */
|
|
1440
|
+
deepValidationUseRelevanceReranker?: boolean;
|
|
1441
|
+
}
|
|
1442
|
+
/** Resolved parameters echoed in `structuredResponse.agentParams`. */
|
|
1443
|
+
interface EngagementExpansionResolvedParams {
|
|
1444
|
+
expandFromResponse: string;
|
|
1445
|
+
hops: number;
|
|
1446
|
+
postsPerHop?: number | null;
|
|
1447
|
+
peoplePerNextHop: number;
|
|
1448
|
+
limit: number;
|
|
1449
|
+
excludeUrls?: string[] | null;
|
|
1450
|
+
}
|
|
1451
|
+
/** Collection statistics for one expansion hop. */
|
|
1452
|
+
interface EngagementExpansionHopStats {
|
|
1453
|
+
hop: number;
|
|
1454
|
+
postsPulled: number;
|
|
1455
|
+
newPeople: number;
|
|
1456
|
+
refinds: number;
|
|
1457
|
+
refindsMergedAsNewEdges: number;
|
|
1458
|
+
authorColleaguesExcluded: number;
|
|
1459
|
+
credits: number;
|
|
1460
|
+
stopReason: string;
|
|
1461
|
+
}
|
|
1462
|
+
/** Collection and finalist-history accounting for an expansion run. */
|
|
1463
|
+
interface EngagementExpansionStats {
|
|
1464
|
+
hopsRun: number;
|
|
1465
|
+
hopsRequested: number;
|
|
1466
|
+
postsPerHop: number;
|
|
1467
|
+
postsPerHopSource: 'requested' | 'derived';
|
|
1468
|
+
/** Hop collection only; enrichment and validation use standard deep-search economics. */
|
|
1469
|
+
collectionCreditsSpent: number;
|
|
1470
|
+
collectionCreditCeiling: number;
|
|
1471
|
+
stopReason: string;
|
|
1472
|
+
perHop: EngagementExpansionHopStats[];
|
|
1473
|
+
/** Credits spent loading broader engagement history for finalists. */
|
|
1474
|
+
finalistHistoryCredits?: number;
|
|
1475
|
+
/** Finalists for whom broader engagement history was available. */
|
|
1476
|
+
finalistsWithHistory?: number;
|
|
1477
|
+
}
|
|
1478
|
+
/** A recent LinkedIn reaction used to give validation broader behavioral context. */
|
|
1479
|
+
interface EngagementHistoryEntry {
|
|
1480
|
+
when?: string | null;
|
|
1481
|
+
reactionType?: string | null;
|
|
1482
|
+
postAuthor?: string | null;
|
|
1483
|
+
postUrl?: string | null;
|
|
1484
|
+
postText?: string | null;
|
|
1485
|
+
}
|
|
1486
|
+
/** Full structured output from a succeeded `engagement_expansion` run. */
|
|
1487
|
+
interface EngagementExpansionOutput {
|
|
1488
|
+
/** Validated candidates, preserving the backend's scoring order and capped to `limit`. */
|
|
1489
|
+
candidates: ValidatedCandidate[];
|
|
1490
|
+
criteria?: CriteriaMetadata;
|
|
1491
|
+
expansionStats?: EngagementExpansionStats;
|
|
1492
|
+
agentParams: EngagementExpansionResolvedParams;
|
|
1493
|
+
}
|
|
1494
|
+
|
|
1390
1495
|
/**
|
|
1391
1496
|
* Available people search data sources
|
|
1392
1497
|
*/
|
|
@@ -1815,6 +1920,12 @@ interface ValidatedCandidate {
|
|
|
1815
1920
|
currentCompany?: string;
|
|
1816
1921
|
/** Location */
|
|
1817
1922
|
location?: string;
|
|
1923
|
+
/** Location resolved by validation, including an evidence-based inference when needed. */
|
|
1924
|
+
primaryLocation?: string | null;
|
|
1925
|
+
/** Evidence and reasoning used to resolve `primaryLocation`. */
|
|
1926
|
+
locationReasoning?: string | null;
|
|
1927
|
+
/** Provenance for an inferred `location`, such as `inferred:validation`. */
|
|
1928
|
+
locationSource?: string | null;
|
|
1818
1929
|
/** Profile picture URL */
|
|
1819
1930
|
profilePictureUrl?: string;
|
|
1820
1931
|
/** Overall match score (0-10) */
|
|
@@ -1827,6 +1938,8 @@ interface ValidatedCandidate {
|
|
|
1827
1938
|
criterionResults?: CriterionResult[];
|
|
1828
1939
|
/** Criterion results emitted by deep_people_search and people_scoring. */
|
|
1829
1940
|
deepCriteria?: CriterionResult[];
|
|
1941
|
+
/** Number of criteria actually judged by an LLM; zero means the candidate was unjudged. */
|
|
1942
|
+
criteriaJudged?: number;
|
|
1830
1943
|
/** Warnings about criteria that couldn't be fully verified */
|
|
1831
1944
|
criteriaQualityWarnings?: string[];
|
|
1832
1945
|
/** Explanation of LinkedIn engagement relevance (if applicable) */
|
|
@@ -1858,6 +1971,17 @@ interface ValidatedCandidate {
|
|
|
1858
1971
|
relevanceTier?: RelevanceTier;
|
|
1859
1972
|
/** One-line reranker justification grounded in candidate data. */
|
|
1860
1973
|
relevanceReason?: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* Backend-authored delivery tier. Current runs use 3 for judged/in-region,
|
|
1976
|
+
* 2 for judged/out-of-region, and 0 for unjudged. Tier 1 may exist on older responses.
|
|
1977
|
+
*/
|
|
1978
|
+
rankTier?: 0 | 1 | 2 | 3;
|
|
1979
|
+
/** Whether the candidate satisfies the search's location requirement. */
|
|
1980
|
+
geoOk?: boolean;
|
|
1981
|
+
/** Model's direct answer to the location requirement, when one exists. */
|
|
1982
|
+
llmRegionMatch?: boolean | null;
|
|
1983
|
+
/** Reasoning behind `llmRegionMatch`. */
|
|
1984
|
+
llmRegionMatchReasoning?: string | null;
|
|
1861
1985
|
/**
|
|
1862
1986
|
* Primary current operating role from the reranker (main full-time job, not side/advisory).
|
|
1863
1987
|
* Also written to `currentTitle` when present.
|
|
@@ -1873,13 +1997,12 @@ interface ValidatedCandidate {
|
|
|
1873
1997
|
enrichedCurrentCompany?: string;
|
|
1874
1998
|
/**
|
|
1875
1999
|
* True when the candidate failed at least one universal or post_hard (must-have) criterion.
|
|
1876
|
-
*
|
|
1877
|
-
* of relevance score.
|
|
2000
|
+
* This affects scoring and routing but no longer forces a lower delivery tier.
|
|
1878
2001
|
*/
|
|
1879
2002
|
anyUniversalFailed?: boolean;
|
|
1880
2003
|
/**
|
|
1881
2004
|
* True when promoted from excluded to meet the requested count despite failing hard
|
|
1882
|
-
* criteria.
|
|
2005
|
+
* criteria. This is useful for display and auditing but no longer forces a lower rank tier.
|
|
1883
2006
|
*/
|
|
1884
2007
|
backfilled?: boolean;
|
|
1885
2008
|
/**
|
|
@@ -1890,6 +2013,12 @@ interface ValidatedCandidate {
|
|
|
1890
2013
|
* competitor_post_engagement (with competitor provenance joined in).
|
|
1891
2014
|
*/
|
|
1892
2015
|
engagementData?: PostEngagementData[];
|
|
2016
|
+
/** Broader recent reaction history loaded for engagement-expansion finalists. */
|
|
2017
|
+
engagementHistory?: EngagementHistoryEntry[];
|
|
2018
|
+
/** Number of history records found while preparing a later expansion hop. */
|
|
2019
|
+
engagementHistoryCount?: number;
|
|
2020
|
+
/** True when a later hop found this person through an additional independent post. */
|
|
2021
|
+
refoundOnNewPost?: boolean;
|
|
1893
2022
|
/** Source of candidate data */
|
|
1894
2023
|
source?: string;
|
|
1895
2024
|
/** When source is job_signal: hiring-company context from CrustData job listings */
|
|
@@ -2000,12 +2129,14 @@ interface StructuredResponse extends Record<string, any> {
|
|
|
2000
2129
|
outputs?: ContentIntelligenceOutputs;
|
|
2001
2130
|
coverage?: ContentIntelligenceCoverage;
|
|
2002
2131
|
audienceStats?: ContentIntelligenceAudienceStats | Record<string, never>;
|
|
2132
|
+
/** Engagement expansion output (when using engagement_expansion agent). */
|
|
2133
|
+
expansionStats?: EngagementExpansionStats;
|
|
2003
2134
|
}
|
|
2004
2135
|
/**
|
|
2005
2136
|
* Available specialized agents
|
|
2006
2137
|
* Using a union type that can be extended with any string to support future agents
|
|
2007
2138
|
*/
|
|
2008
|
-
type SpecializedAgentType = 'quick_people_search' | 'deep_people_search' | 'people_scoring' | 'competitor_post_engagement' | 'competitor_rep_engagement' | 'content_intelligence' | (string & {});
|
|
2139
|
+
type SpecializedAgentType = 'quick_people_search' | 'deep_people_search' | 'people_scoring' | 'competitor_post_engagement' | 'competitor_rep_engagement' | 'content_intelligence' | 'engagement_expansion' | (string & {});
|
|
2009
2140
|
/**
|
|
2010
2141
|
* Shared posts date-range enum (deep_people_search, competitor_post_engagement,
|
|
2011
2142
|
* competitor_rep_engagement).
|
|
@@ -2119,6 +2250,16 @@ interface SpecializedAgentParams {
|
|
|
2119
2250
|
* Used by content_intelligence.
|
|
2120
2251
|
*/
|
|
2121
2252
|
outputs?: ContentIntelligenceOutputName[];
|
|
2253
|
+
/** Saved content-intelligence response whose package seeds the expansion. */
|
|
2254
|
+
expandFromResponse?: string;
|
|
2255
|
+
/** Outward rounds to walk. Minimum 1; defaults to 1. */
|
|
2256
|
+
hops?: number;
|
|
2257
|
+
/** Answering posts per hop. Minimum 1; omitted derives breadth from `limit`. */
|
|
2258
|
+
postsPerHop?: number;
|
|
2259
|
+
/** Highest-fit people carried into the next hop. Minimum 1; defaults to 20. */
|
|
2260
|
+
peoplePerNextHop?: number;
|
|
2261
|
+
/** LinkedIn profile URLs excluded in addition to the source package audience. */
|
|
2262
|
+
excludeUrls?: string[];
|
|
2122
2263
|
/**
|
|
2123
2264
|
* Results requested from each Exa query in the people-search research lane.
|
|
2124
2265
|
* Minimum 1; omitted uses the lane default of 100.
|
|
@@ -2517,7 +2658,7 @@ interface CreateResponseRequest {
|
|
|
2517
2658
|
* Route to a specialized agent instead of the main Lumnis agent
|
|
2518
2659
|
* Known agents: 'quick_people_search', 'deep_people_search', 'people_scoring',
|
|
2519
2660
|
* 'competitor_post_engagement', 'competitor_rep_engagement',
|
|
2520
|
-
* 'content_intelligence'
|
|
2661
|
+
* 'content_intelligence', 'engagement_expansion'
|
|
2521
2662
|
* Accepts any string to support future agents without SDK updates
|
|
2522
2663
|
*/
|
|
2523
2664
|
specializedAgent?: SpecializedAgentType;
|
|
@@ -6325,6 +6466,7 @@ declare class ResponsesResource {
|
|
|
6325
6466
|
private _validateCompetitorPostEngagementParams;
|
|
6326
6467
|
private _validateCompetitorRepEngagementParams;
|
|
6327
6468
|
private _validateContentIntelligenceParams;
|
|
6469
|
+
private _validateEngagementExpansionParams;
|
|
6328
6470
|
private _validateCriteriaParams;
|
|
6329
6471
|
private _validateFileReference;
|
|
6330
6472
|
/**
|
|
@@ -6529,6 +6671,22 @@ declare class ResponsesResource {
|
|
|
6529
6671
|
* Omit `outputs` to use the backend's default set.
|
|
6530
6672
|
*/
|
|
6531
6673
|
contentIntelligence(query: string, options?: ContentIntelligenceOptions): Promise<CreateResponseResponse>;
|
|
6674
|
+
/**
|
|
6675
|
+
* Find new people by walking outward from a saved content-intelligence package.
|
|
6676
|
+
*
|
|
6677
|
+
* Hop 1 pulls the other engagers of the package's best posts. Additional hops
|
|
6678
|
+
* select the highest-fit new people, rank posts from their feeds, and pull the
|
|
6679
|
+
* engagers of those posts. Collection breadth is derived from `limit` unless
|
|
6680
|
+
* `postsPerHop` is set explicitly. At the default limit, collection is about
|
|
6681
|
+
* 300 credits for one hop and 1,060 for three hops; enrichment and validation
|
|
6682
|
+
* use the standard deep-search economics on top.
|
|
6683
|
+
*
|
|
6684
|
+
* @param query - Persona prompt used to rank and validate discovered people.
|
|
6685
|
+
* @param options - Source response plus hop, breadth, limit, and exclusion controls.
|
|
6686
|
+
* @returns Response; poll with `get()` and read `structuredResponse` as
|
|
6687
|
+
* {@link EngagementExpansionOutput}.
|
|
6688
|
+
*/
|
|
6689
|
+
engagementExpansion(query: string, options: EngagementExpansionOptions): Promise<CreateResponseResponse>;
|
|
6532
6690
|
/**
|
|
6533
6691
|
* Score people who reacted to or commented on competitor LinkedIn posts.
|
|
6534
6692
|
*
|
|
@@ -8181,4 +8339,4 @@ declare class ProgressTracker {
|
|
|
8181
8339
|
*/
|
|
8182
8340
|
declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
|
|
8183
8341
|
|
|
8184
|
-
export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type Channel, type ChannelContactHistory, type ChannelFunnel, type ChannelRatios, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type ColumnKind, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectInboxRequest, type ConnectInboxResponse, type Connection, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsResponse, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactFinding, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, type ContentIntelligenceAudienceStats, type ContentIntelligenceAuthor, type ContentIntelligenceCoverage, type ContentIntelligenceCoveragePerson, type ContentIntelligenceCurationStats, type ContentIntelligenceDateValue, type ContentIntelligenceEngager, type ContentIntelligenceOptions, type ContentIntelligenceOutput, type ContentIntelligenceOutputName, type ContentIntelligenceOutputs, type ContentIntelligencePackage, type ContentIntelligencePost, type ContentIntelligenceResolvedParams, type ContentIntelligenceSummary, type ContentLimit, type ContentSource, type ContentType, type ConversationDetail, ConversationStatus, type ConversationSummary, type CreateDraftRequest, type CreateFeedbackRequest, type CreateFeedbackResponse, type CreateResponseRequest, type CreateResponseResponse, type CreateThreadRequest, type CriteriaClassification, type CriteriaMetadata, type CriterionDefinition, type CriterionResult, type CriterionType, type CrmContactInput, type CrmContactsSyncRequest, type CrmContactsSyncResponse, type CrmContactsSyncStatusResponse, type CrmExclusionGrantListResponse, type CrmExclusionGrantRequest, type CrmExclusionGrantResponse, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailInboxItem, type EmailInboxListResponse, type EmailInboxPersona, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, type EmailThreadSummary, type EngagementAnalysisOutput, type EngagementAnalysisScope, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, EnrichmentResource, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, type EvidenceSource, type ExecutionDetailResponse, type ExecutionEvent, type ExecutionEventData, type ExecutionListResponse, type ExecutionMetricsOptions, type ExecutionMetricsResponse, type ExecutionStatus, type ExecutionSummary, type ExecutionSummaryExtended, type ExecutionsParams, type ExecutionsRequestItem, type ExecutionsResponseItem, ExternalAPIKeysResource, type ExternalApiKeyResponse, type FeedbackListResponse, type FeedbackObject, type FeedbackType, type FileAttachment, type FileChunk, type FileContentResponse, type FileListResponse, type FileMetadata, type FileScope, type FileScopeUpdateRequest, type FileSearchRequest, type FileSearchResponse, type FileSearchResult, type FileStatisticsResponse, type FileUploadResponse, FilesResource, type FilterLogic, type FilterValue, type FunnelStage, type GetConnectionStatusParams, type GetContactRelationshipsOptions, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InboxKind, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type ListAcceptedConnectionsParams, type ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListConnectionsParams, type ListExecutionsOptions, type ListInboxesParams, type ListPendingApprovalsOptions, type ListPlaybooksOptions, type ListProvidersResponse, type ListStepExecutionsOptions, type ListTemplatesOptions, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type MailboxUpdateRequest, type MailboxUpdateResponse, type Message, type MessageReceivedData, type MessageResponse, type MessageSentData, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingResource, MessagingSendError, MessagingValidationError, type MetricsParams, type MetricsRequestItem, type MetricsResponseItem, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NetworkDistance, NoDataSourcesError, NotFoundError, type OnFailure, type Opportunity, type OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, OutreachResource, type OutreachSource, type OutreachStats, type PaginationInfo, type PaginationParams, type PainPoint, type PauseProspectsRequest, type PauseProspectsResponse, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PeriodInsight, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostIdea, type PostIdeasOutput, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RelevanceTier, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type ResumeProspectsRequest, SEQUENCE_RATE_LIMITS, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SenderPersonaInput, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type SequenceRateLimitAction, type SequenceStepCompletedData, type SequenceTemplateCreate, type SequenceTemplateResponse, type SequenceTemplateUpdate, SequencesResource, SharePermission, type SkillAnalyticsRequest, type SkillEffectivenessMetrics, type SkillGuidelineBase, type SkillGuidelineCreate, type SkillGuidelineListResponse, type SkillGuidelineResponse, type SkillGuidelineUpdate, type SkillRetrievalMetadata, type SkillUsageBase, type SkillUsageCreate, type SkillUsageListResponse, type SkillUsageResponse, type SkillUsageUpdate, SkillsResource, type SkipActionRequest, type SkipStepRequest, type SkipStepResponse, type SkippedProspect, type SkippedTransferProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type Stage, type StageFilter, type StandoutPost, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionItem, type StepExecutionListResponse, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoppedBreakdown, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, SyncPhaseStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type Takeaway, type TeardownOrgResponse, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThemeAssignment, type ThemePeriodStats, type ThemeStats, type ThemeTrend, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TopPost, type TopPostsOutput, type TopVoice, type TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
|
|
8342
|
+
export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type Channel, type ChannelContactHistory, type ChannelFunnel, type ChannelRatios, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type ColumnKind, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectInboxRequest, type ConnectInboxResponse, type Connection, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsResponse, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactFinding, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, type ContentIntelligenceAudienceStats, type ContentIntelligenceAuthor, type ContentIntelligenceCoverage, type ContentIntelligenceCoveragePerson, type ContentIntelligenceCurationStats, type ContentIntelligenceDateValue, type ContentIntelligenceEngager, type ContentIntelligenceOptions, type ContentIntelligenceOutput, type ContentIntelligenceOutputName, type ContentIntelligenceOutputs, type ContentIntelligencePackage, type ContentIntelligencePost, type ContentIntelligenceResolvedParams, type ContentIntelligenceSummary, type ContentLimit, type ContentSource, type ContentType, type ConversationDetail, ConversationStatus, type ConversationSummary, type CreateDraftRequest, type CreateFeedbackRequest, type CreateFeedbackResponse, type CreateResponseRequest, type CreateResponseResponse, type CreateThreadRequest, type CriteriaClassification, type CriteriaMetadata, type CriterionDefinition, type CriterionResult, type CriterionType, type CrmContactInput, type CrmContactsSyncRequest, type CrmContactsSyncResponse, type CrmContactsSyncStatusResponse, type CrmExclusionGrantListResponse, type CrmExclusionGrantRequest, type CrmExclusionGrantResponse, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailInboxItem, type EmailInboxListResponse, type EmailInboxPersona, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, type EmailThreadSummary, type EngagementAnalysisOutput, type EngagementAnalysisScope, type EngagementExpansionHopStats, type EngagementExpansionOptions, type EngagementExpansionOutput, type EngagementExpansionResolvedParams, type EngagementExpansionStats, type EngagementHistoryEntry, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, EnrichmentResource, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, type EvidenceSource, type ExecutionDetailResponse, type ExecutionEvent, type ExecutionEventData, type ExecutionListResponse, type ExecutionMetricsOptions, type ExecutionMetricsResponse, type ExecutionStatus, type ExecutionSummary, type ExecutionSummaryExtended, type ExecutionsParams, type ExecutionsRequestItem, type ExecutionsResponseItem, ExternalAPIKeysResource, type ExternalApiKeyResponse, type FeedbackListResponse, type FeedbackObject, type FeedbackType, type FileAttachment, type FileChunk, type FileContentResponse, type FileListResponse, type FileMetadata, type FileScope, type FileScopeUpdateRequest, type FileSearchRequest, type FileSearchResponse, type FileSearchResult, type FileStatisticsResponse, type FileUploadResponse, FilesResource, type FilterLogic, type FilterValue, type FunnelStage, type GetConnectionStatusParams, type GetContactRelationshipsOptions, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InboxKind, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type ListAcceptedConnectionsParams, type ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListConnectionsParams, type ListExecutionsOptions, type ListInboxesParams, type ListPendingApprovalsOptions, type ListPlaybooksOptions, type ListProvidersResponse, type ListStepExecutionsOptions, type ListTemplatesOptions, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type MailboxUpdateRequest, type MailboxUpdateResponse, type Message, type MessageReceivedData, type MessageResponse, type MessageSentData, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingResource, MessagingSendError, MessagingValidationError, type MetricsParams, type MetricsRequestItem, type MetricsResponseItem, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NetworkDistance, NoDataSourcesError, NotFoundError, type OnFailure, type Opportunity, type OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, OutreachResource, type OutreachSource, type OutreachStats, type PaginationInfo, type PaginationParams, type PainPoint, type PauseProspectsRequest, type PauseProspectsResponse, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PeriodInsight, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostIdea, type PostIdeasOutput, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RelevanceTier, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type ResumeProspectsRequest, SEQUENCE_RATE_LIMITS, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SenderPersonaInput, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type SequenceRateLimitAction, type SequenceStepCompletedData, type SequenceTemplateCreate, type SequenceTemplateResponse, type SequenceTemplateUpdate, SequencesResource, SharePermission, type SkillAnalyticsRequest, type SkillEffectivenessMetrics, type SkillGuidelineBase, type SkillGuidelineCreate, type SkillGuidelineListResponse, type SkillGuidelineResponse, type SkillGuidelineUpdate, type SkillRetrievalMetadata, type SkillUsageBase, type SkillUsageCreate, type SkillUsageListResponse, type SkillUsageResponse, type SkillUsageUpdate, SkillsResource, type SkipActionRequest, type SkipStepRequest, type SkipStepResponse, type SkippedProspect, type SkippedTransferProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type Stage, type StageFilter, type StandoutPost, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionItem, type StepExecutionListResponse, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoppedBreakdown, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, SyncPhaseStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type Takeaway, type TeardownOrgResponse, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThemeAssignment, type ThemePeriodStats, type ThemeStats, type ThemeTrend, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TopPost, type TopPostsOutput, type TopVoice, type TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
|
package/dist/index.mjs
CHANGED
|
@@ -3390,6 +3390,32 @@ class ResponsesResource {
|
|
|
3390
3390
|
}
|
|
3391
3391
|
}
|
|
3392
3392
|
}
|
|
3393
|
+
_validateEngagementExpansionParams(params) {
|
|
3394
|
+
const expandFromResponse = this._getParamValue(
|
|
3395
|
+
params,
|
|
3396
|
+
"expandFromResponse",
|
|
3397
|
+
"expand_from_response"
|
|
3398
|
+
);
|
|
3399
|
+
if (typeof expandFromResponse !== "string" || !expandFromResponse.trim()) {
|
|
3400
|
+
throw new ValidationError(
|
|
3401
|
+
"expandFromResponse is required for engagement_expansion and must be a non-empty string"
|
|
3402
|
+
);
|
|
3403
|
+
}
|
|
3404
|
+
for (const [camel, snake] of [
|
|
3405
|
+
["hops", "hops"],
|
|
3406
|
+
["postsPerHop", "posts_per_hop"],
|
|
3407
|
+
["peoplePerNextHop", "people_per_next_hop"],
|
|
3408
|
+
["limit", "limit"]
|
|
3409
|
+
]) {
|
|
3410
|
+
const value = this._getParamValue(params, camel, snake);
|
|
3411
|
+
if (value !== void 0 && (!Number.isInteger(value) || value < 1))
|
|
3412
|
+
throw new ValidationError(`${camel} must be a positive integer for engagement_expansion`);
|
|
3413
|
+
}
|
|
3414
|
+
const excludeUrls = this._getParamValue(params, "excludeUrls", "exclude_urls");
|
|
3415
|
+
if (excludeUrls !== void 0 && (!Array.isArray(excludeUrls) || excludeUrls.some((url) => typeof url !== "string"))) {
|
|
3416
|
+
throw new ValidationError("excludeUrls must be an array of strings for engagement_expansion");
|
|
3417
|
+
}
|
|
3418
|
+
}
|
|
3393
3419
|
_validateCriteriaParams(params, specializedAgent) {
|
|
3394
3420
|
if (!params)
|
|
3395
3421
|
return;
|
|
@@ -3503,6 +3529,8 @@ class ResponsesResource {
|
|
|
3503
3529
|
this._validateCompetitorRepEngagementParams(rawParams);
|
|
3504
3530
|
if (specializedAgent === "content_intelligence")
|
|
3505
3531
|
this._validateContentIntelligenceParams(rawParams);
|
|
3532
|
+
if (specializedAgent === "engagement_expansion")
|
|
3533
|
+
this._validateEngagementExpansionParams(rawParams);
|
|
3506
3534
|
}
|
|
3507
3535
|
_validateFileReference(uri) {
|
|
3508
3536
|
if (uri.startsWith("artifact_"))
|
|
@@ -3851,6 +3879,46 @@ class ResponsesResource {
|
|
|
3851
3879
|
specializedAgentParams: params
|
|
3852
3880
|
});
|
|
3853
3881
|
}
|
|
3882
|
+
/**
|
|
3883
|
+
* Find new people by walking outward from a saved content-intelligence package.
|
|
3884
|
+
*
|
|
3885
|
+
* Hop 1 pulls the other engagers of the package's best posts. Additional hops
|
|
3886
|
+
* select the highest-fit new people, rank posts from their feeds, and pull the
|
|
3887
|
+
* engagers of those posts. Collection breadth is derived from `limit` unless
|
|
3888
|
+
* `postsPerHop` is set explicitly. At the default limit, collection is about
|
|
3889
|
+
* 300 credits for one hop and 1,060 for three hops; enrichment and validation
|
|
3890
|
+
* use the standard deep-search economics on top.
|
|
3891
|
+
*
|
|
3892
|
+
* @param query - Persona prompt used to rank and validate discovered people.
|
|
3893
|
+
* @param options - Source response plus hop, breadth, limit, and exclusion controls.
|
|
3894
|
+
* @returns Response; poll with `get()` and read `structuredResponse` as
|
|
3895
|
+
* {@link EngagementExpansionOutput}.
|
|
3896
|
+
*/
|
|
3897
|
+
async engagementExpansion(query, options) {
|
|
3898
|
+
if (!query.trim())
|
|
3899
|
+
throw new ValidationError("engagementExpansion requires a non-empty persona query");
|
|
3900
|
+
const params = {
|
|
3901
|
+
expandFromResponse: options?.expandFromResponse
|
|
3902
|
+
};
|
|
3903
|
+
if (options?.hops !== void 0)
|
|
3904
|
+
params.hops = options.hops;
|
|
3905
|
+
if (options?.postsPerHop !== void 0)
|
|
3906
|
+
params.postsPerHop = options.postsPerHop;
|
|
3907
|
+
if (options?.peoplePerNextHop !== void 0)
|
|
3908
|
+
params.peoplePerNextHop = options.peoplePerNextHop;
|
|
3909
|
+
if (options?.limit !== void 0)
|
|
3910
|
+
params.limit = options.limit;
|
|
3911
|
+
if (options?.excludeUrls !== void 0)
|
|
3912
|
+
params.excludeUrls = options.excludeUrls;
|
|
3913
|
+
if (options?.deepValidationUseRelevanceReranker !== void 0) {
|
|
3914
|
+
params.deepValidationUseRelevanceReranker = options.deepValidationUseRelevanceReranker;
|
|
3915
|
+
}
|
|
3916
|
+
return this.create({
|
|
3917
|
+
messages: [{ role: "user", content: query }],
|
|
3918
|
+
specializedAgent: "engagement_expansion",
|
|
3919
|
+
specializedAgentParams: params
|
|
3920
|
+
});
|
|
3921
|
+
}
|
|
3854
3922
|
/**
|
|
3855
3923
|
* Score people who reacted to or commented on competitor LinkedIn posts.
|
|
3856
3924
|
*
|