lumnisai 0.5.14 → 0.5.16
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 +113 -0
- package/dist/index.d.cts +186 -2
- package/dist/index.d.mts +186 -2
- package/dist/index.d.ts +186 -2
- package/dist/index.mjs +113 -0
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -922,6 +922,114 @@ class ContactRelationshipsResource {
|
|
|
922
922
|
}
|
|
923
923
|
}
|
|
924
924
|
|
|
925
|
+
class EmailResource {
|
|
926
|
+
constructor(http) {
|
|
927
|
+
this.http = http;
|
|
928
|
+
}
|
|
929
|
+
// ==================== Onboarding ====================
|
|
930
|
+
/**
|
|
931
|
+
* Start onboarding a new organization for email outreach.
|
|
932
|
+
*
|
|
933
|
+
* This provisions domains, mailboxes, and warmup infrastructure.
|
|
934
|
+
* Typically takes 30-60 minutes to complete.
|
|
935
|
+
*/
|
|
936
|
+
async onboard(request) {
|
|
937
|
+
return this.http.post("/email/onboard", request);
|
|
938
|
+
}
|
|
939
|
+
// ==================== Organizations ====================
|
|
940
|
+
/**
|
|
941
|
+
* List email organizations the user has access to.
|
|
942
|
+
*/
|
|
943
|
+
async listOrganizations(userId) {
|
|
944
|
+
return this.http.get("/email/organizations", {
|
|
945
|
+
params: { user_id: userId }
|
|
946
|
+
});
|
|
947
|
+
}
|
|
948
|
+
/**
|
|
949
|
+
* Get onboarding status for an organization.
|
|
950
|
+
*/
|
|
951
|
+
async getOnboardingStatus(orgId, userId) {
|
|
952
|
+
return this.http.get(
|
|
953
|
+
`/email/organizations/${encodeURIComponent(orgId)}/status`,
|
|
954
|
+
{ params: { user_id: userId } }
|
|
955
|
+
);
|
|
956
|
+
}
|
|
957
|
+
/**
|
|
958
|
+
* Get current settings for an organization.
|
|
959
|
+
*/
|
|
960
|
+
async getSettings(orgId, userId) {
|
|
961
|
+
return this.http.get(
|
|
962
|
+
`/email/organizations/${encodeURIComponent(orgId)}/settings`,
|
|
963
|
+
{ params: { user_id: userId } }
|
|
964
|
+
);
|
|
965
|
+
}
|
|
966
|
+
/**
|
|
967
|
+
* Update organization settings. Requires admin role.
|
|
968
|
+
*/
|
|
969
|
+
async updateSettings(orgId, userId, update) {
|
|
970
|
+
return this.http.put(
|
|
971
|
+
`/email/organizations/${encodeURIComponent(orgId)}/settings`,
|
|
972
|
+
update,
|
|
973
|
+
{ params: { user_id: userId } }
|
|
974
|
+
);
|
|
975
|
+
}
|
|
976
|
+
/**
|
|
977
|
+
* Get health summary for an organization.
|
|
978
|
+
*/
|
|
979
|
+
async getHealth(orgId, userId) {
|
|
980
|
+
return this.http.get(
|
|
981
|
+
`/email/organizations/${encodeURIComponent(orgId)}/health`,
|
|
982
|
+
{ params: { user_id: userId } }
|
|
983
|
+
);
|
|
984
|
+
}
|
|
985
|
+
// ==================== Personas ====================
|
|
986
|
+
/**
|
|
987
|
+
* Add a new sender persona to an organization.
|
|
988
|
+
* Provisions mailboxes on existing domains. Requires admin role.
|
|
989
|
+
*/
|
|
990
|
+
async addPersona(orgId, userId, persona) {
|
|
991
|
+
return this.http.post(
|
|
992
|
+
`/email/organizations/${encodeURIComponent(orgId)}/personas`,
|
|
993
|
+
persona,
|
|
994
|
+
{ params: { user_id: userId } }
|
|
995
|
+
);
|
|
996
|
+
}
|
|
997
|
+
// ==================== Teardown ====================
|
|
998
|
+
/**
|
|
999
|
+
* Teardown an email organization's infrastructure.
|
|
1000
|
+
*
|
|
1001
|
+
* Full decommission: cancels warmup, InfraGuard, and mailboxes.
|
|
1002
|
+
* Requires admin role on the org.
|
|
1003
|
+
*/
|
|
1004
|
+
async teardown(orgId, userId) {
|
|
1005
|
+
return this.http.post(
|
|
1006
|
+
`/email/organizations/${encodeURIComponent(orgId)}/teardown`,
|
|
1007
|
+
{},
|
|
1008
|
+
{ params: { user_id: userId } }
|
|
1009
|
+
);
|
|
1010
|
+
}
|
|
1011
|
+
// ==================== Members ====================
|
|
1012
|
+
/**
|
|
1013
|
+
* Add a user to an organization. Requires admin role.
|
|
1014
|
+
*/
|
|
1015
|
+
async addMember(orgId, userId, member) {
|
|
1016
|
+
return this.http.post(
|
|
1017
|
+
`/email/organizations/${encodeURIComponent(orgId)}/members`,
|
|
1018
|
+
member,
|
|
1019
|
+
{ params: { user_id: userId } }
|
|
1020
|
+
);
|
|
1021
|
+
}
|
|
1022
|
+
/**
|
|
1023
|
+
* Remove a user from an organization. Requires admin role.
|
|
1024
|
+
*/
|
|
1025
|
+
async removeMember(orgId, userId, memberEmail) {
|
|
1026
|
+
return this.http.delete(
|
|
1027
|
+
`/email/organizations/${encodeURIComponent(orgId)}/members/${encodeURIComponent(memberEmail)}`,
|
|
1028
|
+
{ params: { user_id: userId } }
|
|
1029
|
+
);
|
|
1030
|
+
}
|
|
1031
|
+
}
|
|
1032
|
+
|
|
925
1033
|
class EnrichmentResource {
|
|
926
1034
|
constructor(http) {
|
|
927
1035
|
this.http = http;
|
|
@@ -3119,6 +3227,7 @@ class ResponsesResource {
|
|
|
3119
3227
|
* @param options.excludeProfiles - LinkedIn URLs to exclude from results
|
|
3120
3228
|
* @param options.excludePreviouslyContacted - Exclude previously contacted people
|
|
3121
3229
|
* @param options.excludeNames - Names to exclude from results
|
|
3230
|
+
* @param options.searchJobSignal - CrustData job-listing signal search (decision makers at hiring companies); true | false | 'auto'
|
|
3122
3231
|
* @returns Response with structured_response containing:
|
|
3123
3232
|
* - candidates: Validated and scored candidates
|
|
3124
3233
|
* - criteria: Generated/reused criteria definitions and classification
|
|
@@ -3179,6 +3288,8 @@ class ResponsesResource {
|
|
|
3179
3288
|
params.engagementScoreWeight = options.engagementScoreWeight;
|
|
3180
3289
|
if (options.postsExtractAuthor !== void 0)
|
|
3181
3290
|
params.postsExtractAuthor = options.postsExtractAuthor;
|
|
3291
|
+
if (options.searchJobSignal !== void 0)
|
|
3292
|
+
params.searchJobSignal = options.searchJobSignal;
|
|
3182
3293
|
if (Object.keys(params).length > 0)
|
|
3183
3294
|
request.specializedAgentParams = params;
|
|
3184
3295
|
}
|
|
@@ -4162,6 +4273,7 @@ class LumnisClient {
|
|
|
4162
4273
|
campaigns;
|
|
4163
4274
|
contactRelationships;
|
|
4164
4275
|
enrichment;
|
|
4276
|
+
email;
|
|
4165
4277
|
_scopedUserId;
|
|
4166
4278
|
_defaultScope;
|
|
4167
4279
|
constructor(options = {}) {
|
|
@@ -4198,6 +4310,7 @@ class LumnisClient {
|
|
|
4198
4310
|
this.campaigns = new CampaignsResource(this.http);
|
|
4199
4311
|
this.contactRelationships = new ContactRelationshipsResource(this.http);
|
|
4200
4312
|
this.enrichment = new EnrichmentResource(this.http);
|
|
4313
|
+
this.email = new EmailResource(this.http);
|
|
4201
4314
|
}
|
|
4202
4315
|
forUser(userId) {
|
|
4203
4316
|
return new LumnisClient({
|
package/dist/index.d.cts
CHANGED
|
@@ -1003,6 +1003,11 @@ interface ValidatedCandidate {
|
|
|
1003
1003
|
engagementReasoning?: string | null;
|
|
1004
1004
|
/** Source of candidate data */
|
|
1005
1005
|
source?: string;
|
|
1006
|
+
/** When source is job_signal: hiring-company context from CrustData job listings */
|
|
1007
|
+
jobSignalMetadata?: {
|
|
1008
|
+
companyId?: number | null;
|
|
1009
|
+
jobCount?: number;
|
|
1010
|
+
};
|
|
1006
1011
|
/** Raw profile data */
|
|
1007
1012
|
[key: string]: any;
|
|
1008
1013
|
}
|
|
@@ -1047,6 +1052,8 @@ interface DeepSearchStats {
|
|
|
1047
1052
|
batchesTotal?: number;
|
|
1048
1053
|
/** Posts search statistics (when posts search was used) */
|
|
1049
1054
|
postsSearch?: PostsSearchStats | null;
|
|
1055
|
+
/** Job signal pipeline stats (companies found, confirmed, decision makers), when job signal search ran */
|
|
1056
|
+
jobSignalPrefilterStats?: Record<string, unknown> | null;
|
|
1050
1057
|
}
|
|
1051
1058
|
/**
|
|
1052
1059
|
* Structured output from deep_people_search specialized agent.
|
|
@@ -1295,6 +1302,14 @@ interface SpecializedAgentParams {
|
|
|
1295
1302
|
* Used by deep_people_search.
|
|
1296
1303
|
*/
|
|
1297
1304
|
searchConnections?: boolean;
|
|
1305
|
+
/**
|
|
1306
|
+
* Search for decision makers at companies with active hiring signals (CrustData job listings).
|
|
1307
|
+
* Options: true (always), false (never), 'auto' (enable when profile search is classified as needed).
|
|
1308
|
+
* Requires CrustData API access; uses additional credits (~15–50 per run).
|
|
1309
|
+
* @default false
|
|
1310
|
+
* Used by deep_people_search.
|
|
1311
|
+
*/
|
|
1312
|
+
searchJobSignal?: boolean | 'auto';
|
|
1298
1313
|
/**
|
|
1299
1314
|
* Additional parameters for any specialized agent
|
|
1300
1315
|
* This allows flexibility for future agents without SDK updates
|
|
@@ -1651,6 +1666,9 @@ interface ApprovalSettings {
|
|
|
1651
1666
|
sendFollowUpLinkedin?: ApprovalMode;
|
|
1652
1667
|
sendInmailLinkedin?: ApprovalMode;
|
|
1653
1668
|
replyLinkedin?: ApprovalMode;
|
|
1669
|
+
sendInitialEmail?: ApprovalMode;
|
|
1670
|
+
sendFollowUpEmail?: ApprovalMode;
|
|
1671
|
+
replyEmail?: ApprovalMode;
|
|
1654
1672
|
stop?: ApprovalMode;
|
|
1655
1673
|
}
|
|
1656
1674
|
interface PlaybookCreate {
|
|
@@ -1711,6 +1729,7 @@ interface CampaignCreate {
|
|
|
1711
1729
|
guardrails?: CampaignGuardrails;
|
|
1712
1730
|
approvalSettings?: ApprovalSettings;
|
|
1713
1731
|
maxProspects?: number;
|
|
1732
|
+
emailPersonaId?: string;
|
|
1714
1733
|
}
|
|
1715
1734
|
interface CampaignUpdate {
|
|
1716
1735
|
name?: string;
|
|
@@ -1721,6 +1740,7 @@ interface CampaignUpdate {
|
|
|
1721
1740
|
guardrails?: CampaignGuardrails;
|
|
1722
1741
|
approvalSettings?: ApprovalSettings;
|
|
1723
1742
|
maxProspects?: number;
|
|
1743
|
+
emailPersonaId?: string;
|
|
1724
1744
|
}
|
|
1725
1745
|
interface CampaignResponse {
|
|
1726
1746
|
id: string;
|
|
@@ -1737,6 +1757,7 @@ interface CampaignResponse {
|
|
|
1737
1757
|
status: CampaignStatus;
|
|
1738
1758
|
approvalSettings: ApprovalSettings;
|
|
1739
1759
|
maxProspects?: number | null;
|
|
1760
|
+
emailPersonaId?: string | null;
|
|
1740
1761
|
startedAt?: string | null;
|
|
1741
1762
|
pausedAt?: string | null;
|
|
1742
1763
|
terminalProspectCount: number;
|
|
@@ -1781,6 +1802,7 @@ interface CampaignProspectResponse {
|
|
|
1781
1802
|
lastActionType?: string | null;
|
|
1782
1803
|
followUpCount: number;
|
|
1783
1804
|
senderAccountId?: string | null;
|
|
1805
|
+
senderMailboxId?: string | null;
|
|
1784
1806
|
pendingActionId?: string | null;
|
|
1785
1807
|
previousState?: string | null;
|
|
1786
1808
|
snoozedUntil?: string | null;
|
|
@@ -1792,7 +1814,7 @@ interface CampaignProspectResponse {
|
|
|
1792
1814
|
createdAt: string;
|
|
1793
1815
|
updatedAt: string;
|
|
1794
1816
|
}
|
|
1795
|
-
type CampaignActionType = 'smart_like_linkedin' | 'smart_comment_linkedin' | 'reaction_like_linkedin' | 'reaction_comment_linkedin' | 'send_connection_linkedin' | 'send_connection_note_linkedin' | 'send_initial_message_linkedin' | 'send_follow_up_linkedin' | 'send_inmail_linkedin' | 'reply_linkedin' | 'meeting_booked' | 'intro_accepted' | 'wait' | 'stop';
|
|
1817
|
+
type CampaignActionType = 'smart_like_linkedin' | 'smart_comment_linkedin' | 'reaction_like_linkedin' | 'reaction_comment_linkedin' | 'send_connection_linkedin' | 'send_connection_note_linkedin' | 'send_initial_message_linkedin' | 'send_follow_up_linkedin' | 'send_inmail_linkedin' | 'reply_linkedin' | 'send_initial_email' | 'send_follow_up_email' | 'reply_email' | 'meeting_booked' | 'intro_accepted' | 'wait' | 'stop';
|
|
1796
1818
|
type CampaignActionStatus = 'pending_approval' | 'approved' | 'edited' | 'skipped' | 'auto_approved' | 'queued' | 'executed' | 'failed' | 'cancelled' | 'cancelled_by_pause' | 'paused';
|
|
1797
1819
|
interface CampaignActionResponse {
|
|
1798
1820
|
id: string;
|
|
@@ -2265,6 +2287,165 @@ declare class ContactRelationshipsResource {
|
|
|
2265
2287
|
get(options: GetContactRelationshipsOptions): Promise<ContactRelationshipResponse>;
|
|
2266
2288
|
}
|
|
2267
2289
|
|
|
2290
|
+
/**
|
|
2291
|
+
* Email infrastructure types.
|
|
2292
|
+
*
|
|
2293
|
+
* These types map to the Python backend endpoints under /v1/email.
|
|
2294
|
+
*/
|
|
2295
|
+
interface SenderPersonaInput {
|
|
2296
|
+
firstName: string;
|
|
2297
|
+
lastName: string;
|
|
2298
|
+
title?: string;
|
|
2299
|
+
}
|
|
2300
|
+
interface ContactDetailsInput {
|
|
2301
|
+
firstName: string;
|
|
2302
|
+
lastName: string;
|
|
2303
|
+
email: string;
|
|
2304
|
+
phone: string;
|
|
2305
|
+
organization: string;
|
|
2306
|
+
addressLine1: string;
|
|
2307
|
+
city: string;
|
|
2308
|
+
state: string;
|
|
2309
|
+
country: string;
|
|
2310
|
+
postalCode: string;
|
|
2311
|
+
}
|
|
2312
|
+
interface EmailOnboardRequest {
|
|
2313
|
+
userId: string;
|
|
2314
|
+
organizationName: string;
|
|
2315
|
+
primaryWebsiteUrl: string;
|
|
2316
|
+
companyDescription?: string;
|
|
2317
|
+
physicalAddress: string;
|
|
2318
|
+
dailyVolume: number;
|
|
2319
|
+
volumeMode?: string;
|
|
2320
|
+
senderPersonas: SenderPersonaInput[];
|
|
2321
|
+
contactDetails: ContactDetailsInput;
|
|
2322
|
+
}
|
|
2323
|
+
interface EmailOrgSettingsUpdate {
|
|
2324
|
+
dailyVolume?: number;
|
|
2325
|
+
physicalAddress?: string;
|
|
2326
|
+
}
|
|
2327
|
+
interface AddPersonaRequest {
|
|
2328
|
+
firstName: string;
|
|
2329
|
+
lastName: string;
|
|
2330
|
+
title?: string;
|
|
2331
|
+
}
|
|
2332
|
+
interface AddOrgMemberRequest {
|
|
2333
|
+
email: string;
|
|
2334
|
+
role?: string;
|
|
2335
|
+
}
|
|
2336
|
+
interface EmailOnboardResponse {
|
|
2337
|
+
organizationId: string;
|
|
2338
|
+
status: string;
|
|
2339
|
+
message: string;
|
|
2340
|
+
}
|
|
2341
|
+
interface EmailOnboardStatusResponse {
|
|
2342
|
+
organizationId: string;
|
|
2343
|
+
organizationName: string;
|
|
2344
|
+
phase: string;
|
|
2345
|
+
domains: Record<string, number>;
|
|
2346
|
+
mailboxes: Record<string, number>;
|
|
2347
|
+
estimatedReadyAt?: string | null;
|
|
2348
|
+
}
|
|
2349
|
+
interface EmailOrgSettingsResponse {
|
|
2350
|
+
organizationId: string;
|
|
2351
|
+
organizationName: string;
|
|
2352
|
+
dailyVolume: number;
|
|
2353
|
+
volumeMode: string;
|
|
2354
|
+
physicalAddress?: string | null;
|
|
2355
|
+
senderPersonas: Array<Record<string, unknown>>;
|
|
2356
|
+
domainsActive: number;
|
|
2357
|
+
mailboxesReady: number;
|
|
2358
|
+
}
|
|
2359
|
+
interface EmailOrgHealthResponse {
|
|
2360
|
+
organizationId: string;
|
|
2361
|
+
domains: Record<string, number>;
|
|
2362
|
+
mailboxes: Record<string, number>;
|
|
2363
|
+
sendsToday: number;
|
|
2364
|
+
dailyCapacity: number;
|
|
2365
|
+
}
|
|
2366
|
+
interface EmailOrgSummary {
|
|
2367
|
+
id: string;
|
|
2368
|
+
name: string;
|
|
2369
|
+
role: string;
|
|
2370
|
+
phase: string;
|
|
2371
|
+
domainsActive: number;
|
|
2372
|
+
mailboxesReady: number;
|
|
2373
|
+
}
|
|
2374
|
+
interface EmailOrgListResponse {
|
|
2375
|
+
organizations: EmailOrgSummary[];
|
|
2376
|
+
}
|
|
2377
|
+
interface AddPersonaResponse {
|
|
2378
|
+
personaId: string;
|
|
2379
|
+
message: string;
|
|
2380
|
+
}
|
|
2381
|
+
interface AddOrgMemberResponse {
|
|
2382
|
+
message: string;
|
|
2383
|
+
}
|
|
2384
|
+
interface RemoveOrgMemberResponse {
|
|
2385
|
+
message: string;
|
|
2386
|
+
}
|
|
2387
|
+
interface TeardownOrgResponse {
|
|
2388
|
+
message: string;
|
|
2389
|
+
}
|
|
2390
|
+
|
|
2391
|
+
/**
|
|
2392
|
+
* Resource for managing email infrastructure.
|
|
2393
|
+
*
|
|
2394
|
+
* Handles onboarding, organization management, sender personas,
|
|
2395
|
+
* and member access for email outreach infrastructure.
|
|
2396
|
+
*/
|
|
2397
|
+
declare class EmailResource {
|
|
2398
|
+
private readonly http;
|
|
2399
|
+
constructor(http: Http);
|
|
2400
|
+
/**
|
|
2401
|
+
* Start onboarding a new organization for email outreach.
|
|
2402
|
+
*
|
|
2403
|
+
* This provisions domains, mailboxes, and warmup infrastructure.
|
|
2404
|
+
* Typically takes 30-60 minutes to complete.
|
|
2405
|
+
*/
|
|
2406
|
+
onboard(request: EmailOnboardRequest): Promise<EmailOnboardResponse>;
|
|
2407
|
+
/**
|
|
2408
|
+
* List email organizations the user has access to.
|
|
2409
|
+
*/
|
|
2410
|
+
listOrganizations(userId: string): Promise<EmailOrgListResponse>;
|
|
2411
|
+
/**
|
|
2412
|
+
* Get onboarding status for an organization.
|
|
2413
|
+
*/
|
|
2414
|
+
getOnboardingStatus(orgId: string, userId: string): Promise<EmailOnboardStatusResponse>;
|
|
2415
|
+
/**
|
|
2416
|
+
* Get current settings for an organization.
|
|
2417
|
+
*/
|
|
2418
|
+
getSettings(orgId: string, userId: string): Promise<EmailOrgSettingsResponse>;
|
|
2419
|
+
/**
|
|
2420
|
+
* Update organization settings. Requires admin role.
|
|
2421
|
+
*/
|
|
2422
|
+
updateSettings(orgId: string, userId: string, update: EmailOrgSettingsUpdate): Promise<EmailOrgSettingsResponse>;
|
|
2423
|
+
/**
|
|
2424
|
+
* Get health summary for an organization.
|
|
2425
|
+
*/
|
|
2426
|
+
getHealth(orgId: string, userId: string): Promise<EmailOrgHealthResponse>;
|
|
2427
|
+
/**
|
|
2428
|
+
* Add a new sender persona to an organization.
|
|
2429
|
+
* Provisions mailboxes on existing domains. Requires admin role.
|
|
2430
|
+
*/
|
|
2431
|
+
addPersona(orgId: string, userId: string, persona: AddPersonaRequest): Promise<AddPersonaResponse>;
|
|
2432
|
+
/**
|
|
2433
|
+
* Teardown an email organization's infrastructure.
|
|
2434
|
+
*
|
|
2435
|
+
* Full decommission: cancels warmup, InfraGuard, and mailboxes.
|
|
2436
|
+
* Requires admin role on the org.
|
|
2437
|
+
*/
|
|
2438
|
+
teardown(orgId: string, userId: string): Promise<TeardownOrgResponse>;
|
|
2439
|
+
/**
|
|
2440
|
+
* Add a user to an organization. Requires admin role.
|
|
2441
|
+
*/
|
|
2442
|
+
addMember(orgId: string, userId: string, member: AddOrgMemberRequest): Promise<AddOrgMemberResponse>;
|
|
2443
|
+
/**
|
|
2444
|
+
* Remove a user from an organization. Requires admin role.
|
|
2445
|
+
*/
|
|
2446
|
+
removeMember(orgId: string, userId: string, memberEmail: string): Promise<RemoveOrgMemberResponse>;
|
|
2447
|
+
}
|
|
2448
|
+
|
|
2268
2449
|
/** Input for one person to enrich */
|
|
2269
2450
|
interface ContactEnrichPersonInput {
|
|
2270
2451
|
linkedinUrl?: string | null;
|
|
@@ -4353,6 +4534,7 @@ declare class ResponsesResource {
|
|
|
4353
4534
|
* @param options.excludeProfiles - LinkedIn URLs to exclude from results
|
|
4354
4535
|
* @param options.excludePreviouslyContacted - Exclude previously contacted people
|
|
4355
4536
|
* @param options.excludeNames - Names to exclude from results
|
|
4537
|
+
* @param options.searchJobSignal - CrustData job-listing signal search (decision makers at hiring companies); true | false | 'auto'
|
|
4356
4538
|
* @returns Response with structured_response containing:
|
|
4357
4539
|
* - candidates: Validated and scored candidates
|
|
4358
4540
|
* - criteria: Generated/reused criteria definitions and classification
|
|
@@ -4388,6 +4570,7 @@ declare class ResponsesResource {
|
|
|
4388
4570
|
postsEnableFiltering?: boolean;
|
|
4389
4571
|
engagementScoreWeight?: number;
|
|
4390
4572
|
postsExtractAuthor?: boolean;
|
|
4573
|
+
searchJobSignal?: boolean | 'auto';
|
|
4391
4574
|
}): Promise<CreateResponseResponse>;
|
|
4392
4575
|
/**
|
|
4393
4576
|
* Score provided candidates against AI-generated or provided criteria
|
|
@@ -5564,6 +5747,7 @@ declare class LumnisClient {
|
|
|
5564
5747
|
readonly campaigns: CampaignsResource;
|
|
5565
5748
|
readonly contactRelationships: ContactRelationshipsResource;
|
|
5566
5749
|
readonly enrichment: EnrichmentResource;
|
|
5750
|
+
readonly email: EmailResource;
|
|
5567
5751
|
private readonly _scopedUserId?;
|
|
5568
5752
|
private readonly _defaultScope;
|
|
5569
5753
|
constructor(options?: LumnisClientOptions);
|
|
@@ -5916,4 +6100,4 @@ declare class ProgressTracker {
|
|
|
5916
6100
|
*/
|
|
5917
6101
|
declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
|
|
5918
6102
|
|
|
5919
|
-
export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, 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 ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsSyncStatus, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, 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, 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 DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailThreadSummary, 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 InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, 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 ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListExecutionsOptions, 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 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 OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, type PaginationInfo, type PaginationParams, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, 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 ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, SEQUENCE_RATE_LIMITS, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, 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, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, 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 TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, 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 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 };
|
|
6103
|
+
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 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 ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, 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, 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 DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailThreadSummary, 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 InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, 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 ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListExecutionsOptions, 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 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 OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, type PaginationInfo, type PaginationParams, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, 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 RemoveOrgMemberResponse, type ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, 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, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, 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 TeardownOrgResponse, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, 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 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
|
@@ -1003,6 +1003,11 @@ interface ValidatedCandidate {
|
|
|
1003
1003
|
engagementReasoning?: string | null;
|
|
1004
1004
|
/** Source of candidate data */
|
|
1005
1005
|
source?: string;
|
|
1006
|
+
/** When source is job_signal: hiring-company context from CrustData job listings */
|
|
1007
|
+
jobSignalMetadata?: {
|
|
1008
|
+
companyId?: number | null;
|
|
1009
|
+
jobCount?: number;
|
|
1010
|
+
};
|
|
1006
1011
|
/** Raw profile data */
|
|
1007
1012
|
[key: string]: any;
|
|
1008
1013
|
}
|
|
@@ -1047,6 +1052,8 @@ interface DeepSearchStats {
|
|
|
1047
1052
|
batchesTotal?: number;
|
|
1048
1053
|
/** Posts search statistics (when posts search was used) */
|
|
1049
1054
|
postsSearch?: PostsSearchStats | null;
|
|
1055
|
+
/** Job signal pipeline stats (companies found, confirmed, decision makers), when job signal search ran */
|
|
1056
|
+
jobSignalPrefilterStats?: Record<string, unknown> | null;
|
|
1050
1057
|
}
|
|
1051
1058
|
/**
|
|
1052
1059
|
* Structured output from deep_people_search specialized agent.
|
|
@@ -1295,6 +1302,14 @@ interface SpecializedAgentParams {
|
|
|
1295
1302
|
* Used by deep_people_search.
|
|
1296
1303
|
*/
|
|
1297
1304
|
searchConnections?: boolean;
|
|
1305
|
+
/**
|
|
1306
|
+
* Search for decision makers at companies with active hiring signals (CrustData job listings).
|
|
1307
|
+
* Options: true (always), false (never), 'auto' (enable when profile search is classified as needed).
|
|
1308
|
+
* Requires CrustData API access; uses additional credits (~15–50 per run).
|
|
1309
|
+
* @default false
|
|
1310
|
+
* Used by deep_people_search.
|
|
1311
|
+
*/
|
|
1312
|
+
searchJobSignal?: boolean | 'auto';
|
|
1298
1313
|
/**
|
|
1299
1314
|
* Additional parameters for any specialized agent
|
|
1300
1315
|
* This allows flexibility for future agents without SDK updates
|
|
@@ -1651,6 +1666,9 @@ interface ApprovalSettings {
|
|
|
1651
1666
|
sendFollowUpLinkedin?: ApprovalMode;
|
|
1652
1667
|
sendInmailLinkedin?: ApprovalMode;
|
|
1653
1668
|
replyLinkedin?: ApprovalMode;
|
|
1669
|
+
sendInitialEmail?: ApprovalMode;
|
|
1670
|
+
sendFollowUpEmail?: ApprovalMode;
|
|
1671
|
+
replyEmail?: ApprovalMode;
|
|
1654
1672
|
stop?: ApprovalMode;
|
|
1655
1673
|
}
|
|
1656
1674
|
interface PlaybookCreate {
|
|
@@ -1711,6 +1729,7 @@ interface CampaignCreate {
|
|
|
1711
1729
|
guardrails?: CampaignGuardrails;
|
|
1712
1730
|
approvalSettings?: ApprovalSettings;
|
|
1713
1731
|
maxProspects?: number;
|
|
1732
|
+
emailPersonaId?: string;
|
|
1714
1733
|
}
|
|
1715
1734
|
interface CampaignUpdate {
|
|
1716
1735
|
name?: string;
|
|
@@ -1721,6 +1740,7 @@ interface CampaignUpdate {
|
|
|
1721
1740
|
guardrails?: CampaignGuardrails;
|
|
1722
1741
|
approvalSettings?: ApprovalSettings;
|
|
1723
1742
|
maxProspects?: number;
|
|
1743
|
+
emailPersonaId?: string;
|
|
1724
1744
|
}
|
|
1725
1745
|
interface CampaignResponse {
|
|
1726
1746
|
id: string;
|
|
@@ -1737,6 +1757,7 @@ interface CampaignResponse {
|
|
|
1737
1757
|
status: CampaignStatus;
|
|
1738
1758
|
approvalSettings: ApprovalSettings;
|
|
1739
1759
|
maxProspects?: number | null;
|
|
1760
|
+
emailPersonaId?: string | null;
|
|
1740
1761
|
startedAt?: string | null;
|
|
1741
1762
|
pausedAt?: string | null;
|
|
1742
1763
|
terminalProspectCount: number;
|
|
@@ -1781,6 +1802,7 @@ interface CampaignProspectResponse {
|
|
|
1781
1802
|
lastActionType?: string | null;
|
|
1782
1803
|
followUpCount: number;
|
|
1783
1804
|
senderAccountId?: string | null;
|
|
1805
|
+
senderMailboxId?: string | null;
|
|
1784
1806
|
pendingActionId?: string | null;
|
|
1785
1807
|
previousState?: string | null;
|
|
1786
1808
|
snoozedUntil?: string | null;
|
|
@@ -1792,7 +1814,7 @@ interface CampaignProspectResponse {
|
|
|
1792
1814
|
createdAt: string;
|
|
1793
1815
|
updatedAt: string;
|
|
1794
1816
|
}
|
|
1795
|
-
type CampaignActionType = 'smart_like_linkedin' | 'smart_comment_linkedin' | 'reaction_like_linkedin' | 'reaction_comment_linkedin' | 'send_connection_linkedin' | 'send_connection_note_linkedin' | 'send_initial_message_linkedin' | 'send_follow_up_linkedin' | 'send_inmail_linkedin' | 'reply_linkedin' | 'meeting_booked' | 'intro_accepted' | 'wait' | 'stop';
|
|
1817
|
+
type CampaignActionType = 'smart_like_linkedin' | 'smart_comment_linkedin' | 'reaction_like_linkedin' | 'reaction_comment_linkedin' | 'send_connection_linkedin' | 'send_connection_note_linkedin' | 'send_initial_message_linkedin' | 'send_follow_up_linkedin' | 'send_inmail_linkedin' | 'reply_linkedin' | 'send_initial_email' | 'send_follow_up_email' | 'reply_email' | 'meeting_booked' | 'intro_accepted' | 'wait' | 'stop';
|
|
1796
1818
|
type CampaignActionStatus = 'pending_approval' | 'approved' | 'edited' | 'skipped' | 'auto_approved' | 'queued' | 'executed' | 'failed' | 'cancelled' | 'cancelled_by_pause' | 'paused';
|
|
1797
1819
|
interface CampaignActionResponse {
|
|
1798
1820
|
id: string;
|
|
@@ -2265,6 +2287,165 @@ declare class ContactRelationshipsResource {
|
|
|
2265
2287
|
get(options: GetContactRelationshipsOptions): Promise<ContactRelationshipResponse>;
|
|
2266
2288
|
}
|
|
2267
2289
|
|
|
2290
|
+
/**
|
|
2291
|
+
* Email infrastructure types.
|
|
2292
|
+
*
|
|
2293
|
+
* These types map to the Python backend endpoints under /v1/email.
|
|
2294
|
+
*/
|
|
2295
|
+
interface SenderPersonaInput {
|
|
2296
|
+
firstName: string;
|
|
2297
|
+
lastName: string;
|
|
2298
|
+
title?: string;
|
|
2299
|
+
}
|
|
2300
|
+
interface ContactDetailsInput {
|
|
2301
|
+
firstName: string;
|
|
2302
|
+
lastName: string;
|
|
2303
|
+
email: string;
|
|
2304
|
+
phone: string;
|
|
2305
|
+
organization: string;
|
|
2306
|
+
addressLine1: string;
|
|
2307
|
+
city: string;
|
|
2308
|
+
state: string;
|
|
2309
|
+
country: string;
|
|
2310
|
+
postalCode: string;
|
|
2311
|
+
}
|
|
2312
|
+
interface EmailOnboardRequest {
|
|
2313
|
+
userId: string;
|
|
2314
|
+
organizationName: string;
|
|
2315
|
+
primaryWebsiteUrl: string;
|
|
2316
|
+
companyDescription?: string;
|
|
2317
|
+
physicalAddress: string;
|
|
2318
|
+
dailyVolume: number;
|
|
2319
|
+
volumeMode?: string;
|
|
2320
|
+
senderPersonas: SenderPersonaInput[];
|
|
2321
|
+
contactDetails: ContactDetailsInput;
|
|
2322
|
+
}
|
|
2323
|
+
interface EmailOrgSettingsUpdate {
|
|
2324
|
+
dailyVolume?: number;
|
|
2325
|
+
physicalAddress?: string;
|
|
2326
|
+
}
|
|
2327
|
+
interface AddPersonaRequest {
|
|
2328
|
+
firstName: string;
|
|
2329
|
+
lastName: string;
|
|
2330
|
+
title?: string;
|
|
2331
|
+
}
|
|
2332
|
+
interface AddOrgMemberRequest {
|
|
2333
|
+
email: string;
|
|
2334
|
+
role?: string;
|
|
2335
|
+
}
|
|
2336
|
+
interface EmailOnboardResponse {
|
|
2337
|
+
organizationId: string;
|
|
2338
|
+
status: string;
|
|
2339
|
+
message: string;
|
|
2340
|
+
}
|
|
2341
|
+
interface EmailOnboardStatusResponse {
|
|
2342
|
+
organizationId: string;
|
|
2343
|
+
organizationName: string;
|
|
2344
|
+
phase: string;
|
|
2345
|
+
domains: Record<string, number>;
|
|
2346
|
+
mailboxes: Record<string, number>;
|
|
2347
|
+
estimatedReadyAt?: string | null;
|
|
2348
|
+
}
|
|
2349
|
+
interface EmailOrgSettingsResponse {
|
|
2350
|
+
organizationId: string;
|
|
2351
|
+
organizationName: string;
|
|
2352
|
+
dailyVolume: number;
|
|
2353
|
+
volumeMode: string;
|
|
2354
|
+
physicalAddress?: string | null;
|
|
2355
|
+
senderPersonas: Array<Record<string, unknown>>;
|
|
2356
|
+
domainsActive: number;
|
|
2357
|
+
mailboxesReady: number;
|
|
2358
|
+
}
|
|
2359
|
+
interface EmailOrgHealthResponse {
|
|
2360
|
+
organizationId: string;
|
|
2361
|
+
domains: Record<string, number>;
|
|
2362
|
+
mailboxes: Record<string, number>;
|
|
2363
|
+
sendsToday: number;
|
|
2364
|
+
dailyCapacity: number;
|
|
2365
|
+
}
|
|
2366
|
+
interface EmailOrgSummary {
|
|
2367
|
+
id: string;
|
|
2368
|
+
name: string;
|
|
2369
|
+
role: string;
|
|
2370
|
+
phase: string;
|
|
2371
|
+
domainsActive: number;
|
|
2372
|
+
mailboxesReady: number;
|
|
2373
|
+
}
|
|
2374
|
+
interface EmailOrgListResponse {
|
|
2375
|
+
organizations: EmailOrgSummary[];
|
|
2376
|
+
}
|
|
2377
|
+
interface AddPersonaResponse {
|
|
2378
|
+
personaId: string;
|
|
2379
|
+
message: string;
|
|
2380
|
+
}
|
|
2381
|
+
interface AddOrgMemberResponse {
|
|
2382
|
+
message: string;
|
|
2383
|
+
}
|
|
2384
|
+
interface RemoveOrgMemberResponse {
|
|
2385
|
+
message: string;
|
|
2386
|
+
}
|
|
2387
|
+
interface TeardownOrgResponse {
|
|
2388
|
+
message: string;
|
|
2389
|
+
}
|
|
2390
|
+
|
|
2391
|
+
/**
|
|
2392
|
+
* Resource for managing email infrastructure.
|
|
2393
|
+
*
|
|
2394
|
+
* Handles onboarding, organization management, sender personas,
|
|
2395
|
+
* and member access for email outreach infrastructure.
|
|
2396
|
+
*/
|
|
2397
|
+
declare class EmailResource {
|
|
2398
|
+
private readonly http;
|
|
2399
|
+
constructor(http: Http);
|
|
2400
|
+
/**
|
|
2401
|
+
* Start onboarding a new organization for email outreach.
|
|
2402
|
+
*
|
|
2403
|
+
* This provisions domains, mailboxes, and warmup infrastructure.
|
|
2404
|
+
* Typically takes 30-60 minutes to complete.
|
|
2405
|
+
*/
|
|
2406
|
+
onboard(request: EmailOnboardRequest): Promise<EmailOnboardResponse>;
|
|
2407
|
+
/**
|
|
2408
|
+
* List email organizations the user has access to.
|
|
2409
|
+
*/
|
|
2410
|
+
listOrganizations(userId: string): Promise<EmailOrgListResponse>;
|
|
2411
|
+
/**
|
|
2412
|
+
* Get onboarding status for an organization.
|
|
2413
|
+
*/
|
|
2414
|
+
getOnboardingStatus(orgId: string, userId: string): Promise<EmailOnboardStatusResponse>;
|
|
2415
|
+
/**
|
|
2416
|
+
* Get current settings for an organization.
|
|
2417
|
+
*/
|
|
2418
|
+
getSettings(orgId: string, userId: string): Promise<EmailOrgSettingsResponse>;
|
|
2419
|
+
/**
|
|
2420
|
+
* Update organization settings. Requires admin role.
|
|
2421
|
+
*/
|
|
2422
|
+
updateSettings(orgId: string, userId: string, update: EmailOrgSettingsUpdate): Promise<EmailOrgSettingsResponse>;
|
|
2423
|
+
/**
|
|
2424
|
+
* Get health summary for an organization.
|
|
2425
|
+
*/
|
|
2426
|
+
getHealth(orgId: string, userId: string): Promise<EmailOrgHealthResponse>;
|
|
2427
|
+
/**
|
|
2428
|
+
* Add a new sender persona to an organization.
|
|
2429
|
+
* Provisions mailboxes on existing domains. Requires admin role.
|
|
2430
|
+
*/
|
|
2431
|
+
addPersona(orgId: string, userId: string, persona: AddPersonaRequest): Promise<AddPersonaResponse>;
|
|
2432
|
+
/**
|
|
2433
|
+
* Teardown an email organization's infrastructure.
|
|
2434
|
+
*
|
|
2435
|
+
* Full decommission: cancels warmup, InfraGuard, and mailboxes.
|
|
2436
|
+
* Requires admin role on the org.
|
|
2437
|
+
*/
|
|
2438
|
+
teardown(orgId: string, userId: string): Promise<TeardownOrgResponse>;
|
|
2439
|
+
/**
|
|
2440
|
+
* Add a user to an organization. Requires admin role.
|
|
2441
|
+
*/
|
|
2442
|
+
addMember(orgId: string, userId: string, member: AddOrgMemberRequest): Promise<AddOrgMemberResponse>;
|
|
2443
|
+
/**
|
|
2444
|
+
* Remove a user from an organization. Requires admin role.
|
|
2445
|
+
*/
|
|
2446
|
+
removeMember(orgId: string, userId: string, memberEmail: string): Promise<RemoveOrgMemberResponse>;
|
|
2447
|
+
}
|
|
2448
|
+
|
|
2268
2449
|
/** Input for one person to enrich */
|
|
2269
2450
|
interface ContactEnrichPersonInput {
|
|
2270
2451
|
linkedinUrl?: string | null;
|
|
@@ -4353,6 +4534,7 @@ declare class ResponsesResource {
|
|
|
4353
4534
|
* @param options.excludeProfiles - LinkedIn URLs to exclude from results
|
|
4354
4535
|
* @param options.excludePreviouslyContacted - Exclude previously contacted people
|
|
4355
4536
|
* @param options.excludeNames - Names to exclude from results
|
|
4537
|
+
* @param options.searchJobSignal - CrustData job-listing signal search (decision makers at hiring companies); true | false | 'auto'
|
|
4356
4538
|
* @returns Response with structured_response containing:
|
|
4357
4539
|
* - candidates: Validated and scored candidates
|
|
4358
4540
|
* - criteria: Generated/reused criteria definitions and classification
|
|
@@ -4388,6 +4570,7 @@ declare class ResponsesResource {
|
|
|
4388
4570
|
postsEnableFiltering?: boolean;
|
|
4389
4571
|
engagementScoreWeight?: number;
|
|
4390
4572
|
postsExtractAuthor?: boolean;
|
|
4573
|
+
searchJobSignal?: boolean | 'auto';
|
|
4391
4574
|
}): Promise<CreateResponseResponse>;
|
|
4392
4575
|
/**
|
|
4393
4576
|
* Score provided candidates against AI-generated or provided criteria
|
|
@@ -5564,6 +5747,7 @@ declare class LumnisClient {
|
|
|
5564
5747
|
readonly campaigns: CampaignsResource;
|
|
5565
5748
|
readonly contactRelationships: ContactRelationshipsResource;
|
|
5566
5749
|
readonly enrichment: EnrichmentResource;
|
|
5750
|
+
readonly email: EmailResource;
|
|
5567
5751
|
private readonly _scopedUserId?;
|
|
5568
5752
|
private readonly _defaultScope;
|
|
5569
5753
|
constructor(options?: LumnisClientOptions);
|
|
@@ -5916,4 +6100,4 @@ declare class ProgressTracker {
|
|
|
5916
6100
|
*/
|
|
5917
6101
|
declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
|
|
5918
6102
|
|
|
5919
|
-
export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, 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 ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsSyncStatus, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, 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, 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 DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailThreadSummary, 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 InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, 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 ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListExecutionsOptions, 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 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 OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, type PaginationInfo, type PaginationParams, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, 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 ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, SEQUENCE_RATE_LIMITS, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, 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, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, 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 TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, 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 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 };
|
|
6103
|
+
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 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 ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, 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, 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 DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailThreadSummary, 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 InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, 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 ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListExecutionsOptions, 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 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 OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, type PaginationInfo, type PaginationParams, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, 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 RemoveOrgMemberResponse, type ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, 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, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, 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 TeardownOrgResponse, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, 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 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
|
@@ -1003,6 +1003,11 @@ interface ValidatedCandidate {
|
|
|
1003
1003
|
engagementReasoning?: string | null;
|
|
1004
1004
|
/** Source of candidate data */
|
|
1005
1005
|
source?: string;
|
|
1006
|
+
/** When source is job_signal: hiring-company context from CrustData job listings */
|
|
1007
|
+
jobSignalMetadata?: {
|
|
1008
|
+
companyId?: number | null;
|
|
1009
|
+
jobCount?: number;
|
|
1010
|
+
};
|
|
1006
1011
|
/** Raw profile data */
|
|
1007
1012
|
[key: string]: any;
|
|
1008
1013
|
}
|
|
@@ -1047,6 +1052,8 @@ interface DeepSearchStats {
|
|
|
1047
1052
|
batchesTotal?: number;
|
|
1048
1053
|
/** Posts search statistics (when posts search was used) */
|
|
1049
1054
|
postsSearch?: PostsSearchStats | null;
|
|
1055
|
+
/** Job signal pipeline stats (companies found, confirmed, decision makers), when job signal search ran */
|
|
1056
|
+
jobSignalPrefilterStats?: Record<string, unknown> | null;
|
|
1050
1057
|
}
|
|
1051
1058
|
/**
|
|
1052
1059
|
* Structured output from deep_people_search specialized agent.
|
|
@@ -1295,6 +1302,14 @@ interface SpecializedAgentParams {
|
|
|
1295
1302
|
* Used by deep_people_search.
|
|
1296
1303
|
*/
|
|
1297
1304
|
searchConnections?: boolean;
|
|
1305
|
+
/**
|
|
1306
|
+
* Search for decision makers at companies with active hiring signals (CrustData job listings).
|
|
1307
|
+
* Options: true (always), false (never), 'auto' (enable when profile search is classified as needed).
|
|
1308
|
+
* Requires CrustData API access; uses additional credits (~15–50 per run).
|
|
1309
|
+
* @default false
|
|
1310
|
+
* Used by deep_people_search.
|
|
1311
|
+
*/
|
|
1312
|
+
searchJobSignal?: boolean | 'auto';
|
|
1298
1313
|
/**
|
|
1299
1314
|
* Additional parameters for any specialized agent
|
|
1300
1315
|
* This allows flexibility for future agents without SDK updates
|
|
@@ -1651,6 +1666,9 @@ interface ApprovalSettings {
|
|
|
1651
1666
|
sendFollowUpLinkedin?: ApprovalMode;
|
|
1652
1667
|
sendInmailLinkedin?: ApprovalMode;
|
|
1653
1668
|
replyLinkedin?: ApprovalMode;
|
|
1669
|
+
sendInitialEmail?: ApprovalMode;
|
|
1670
|
+
sendFollowUpEmail?: ApprovalMode;
|
|
1671
|
+
replyEmail?: ApprovalMode;
|
|
1654
1672
|
stop?: ApprovalMode;
|
|
1655
1673
|
}
|
|
1656
1674
|
interface PlaybookCreate {
|
|
@@ -1711,6 +1729,7 @@ interface CampaignCreate {
|
|
|
1711
1729
|
guardrails?: CampaignGuardrails;
|
|
1712
1730
|
approvalSettings?: ApprovalSettings;
|
|
1713
1731
|
maxProspects?: number;
|
|
1732
|
+
emailPersonaId?: string;
|
|
1714
1733
|
}
|
|
1715
1734
|
interface CampaignUpdate {
|
|
1716
1735
|
name?: string;
|
|
@@ -1721,6 +1740,7 @@ interface CampaignUpdate {
|
|
|
1721
1740
|
guardrails?: CampaignGuardrails;
|
|
1722
1741
|
approvalSettings?: ApprovalSettings;
|
|
1723
1742
|
maxProspects?: number;
|
|
1743
|
+
emailPersonaId?: string;
|
|
1724
1744
|
}
|
|
1725
1745
|
interface CampaignResponse {
|
|
1726
1746
|
id: string;
|
|
@@ -1737,6 +1757,7 @@ interface CampaignResponse {
|
|
|
1737
1757
|
status: CampaignStatus;
|
|
1738
1758
|
approvalSettings: ApprovalSettings;
|
|
1739
1759
|
maxProspects?: number | null;
|
|
1760
|
+
emailPersonaId?: string | null;
|
|
1740
1761
|
startedAt?: string | null;
|
|
1741
1762
|
pausedAt?: string | null;
|
|
1742
1763
|
terminalProspectCount: number;
|
|
@@ -1781,6 +1802,7 @@ interface CampaignProspectResponse {
|
|
|
1781
1802
|
lastActionType?: string | null;
|
|
1782
1803
|
followUpCount: number;
|
|
1783
1804
|
senderAccountId?: string | null;
|
|
1805
|
+
senderMailboxId?: string | null;
|
|
1784
1806
|
pendingActionId?: string | null;
|
|
1785
1807
|
previousState?: string | null;
|
|
1786
1808
|
snoozedUntil?: string | null;
|
|
@@ -1792,7 +1814,7 @@ interface CampaignProspectResponse {
|
|
|
1792
1814
|
createdAt: string;
|
|
1793
1815
|
updatedAt: string;
|
|
1794
1816
|
}
|
|
1795
|
-
type CampaignActionType = 'smart_like_linkedin' | 'smart_comment_linkedin' | 'reaction_like_linkedin' | 'reaction_comment_linkedin' | 'send_connection_linkedin' | 'send_connection_note_linkedin' | 'send_initial_message_linkedin' | 'send_follow_up_linkedin' | 'send_inmail_linkedin' | 'reply_linkedin' | 'meeting_booked' | 'intro_accepted' | 'wait' | 'stop';
|
|
1817
|
+
type CampaignActionType = 'smart_like_linkedin' | 'smart_comment_linkedin' | 'reaction_like_linkedin' | 'reaction_comment_linkedin' | 'send_connection_linkedin' | 'send_connection_note_linkedin' | 'send_initial_message_linkedin' | 'send_follow_up_linkedin' | 'send_inmail_linkedin' | 'reply_linkedin' | 'send_initial_email' | 'send_follow_up_email' | 'reply_email' | 'meeting_booked' | 'intro_accepted' | 'wait' | 'stop';
|
|
1796
1818
|
type CampaignActionStatus = 'pending_approval' | 'approved' | 'edited' | 'skipped' | 'auto_approved' | 'queued' | 'executed' | 'failed' | 'cancelled' | 'cancelled_by_pause' | 'paused';
|
|
1797
1819
|
interface CampaignActionResponse {
|
|
1798
1820
|
id: string;
|
|
@@ -2265,6 +2287,165 @@ declare class ContactRelationshipsResource {
|
|
|
2265
2287
|
get(options: GetContactRelationshipsOptions): Promise<ContactRelationshipResponse>;
|
|
2266
2288
|
}
|
|
2267
2289
|
|
|
2290
|
+
/**
|
|
2291
|
+
* Email infrastructure types.
|
|
2292
|
+
*
|
|
2293
|
+
* These types map to the Python backend endpoints under /v1/email.
|
|
2294
|
+
*/
|
|
2295
|
+
interface SenderPersonaInput {
|
|
2296
|
+
firstName: string;
|
|
2297
|
+
lastName: string;
|
|
2298
|
+
title?: string;
|
|
2299
|
+
}
|
|
2300
|
+
interface ContactDetailsInput {
|
|
2301
|
+
firstName: string;
|
|
2302
|
+
lastName: string;
|
|
2303
|
+
email: string;
|
|
2304
|
+
phone: string;
|
|
2305
|
+
organization: string;
|
|
2306
|
+
addressLine1: string;
|
|
2307
|
+
city: string;
|
|
2308
|
+
state: string;
|
|
2309
|
+
country: string;
|
|
2310
|
+
postalCode: string;
|
|
2311
|
+
}
|
|
2312
|
+
interface EmailOnboardRequest {
|
|
2313
|
+
userId: string;
|
|
2314
|
+
organizationName: string;
|
|
2315
|
+
primaryWebsiteUrl: string;
|
|
2316
|
+
companyDescription?: string;
|
|
2317
|
+
physicalAddress: string;
|
|
2318
|
+
dailyVolume: number;
|
|
2319
|
+
volumeMode?: string;
|
|
2320
|
+
senderPersonas: SenderPersonaInput[];
|
|
2321
|
+
contactDetails: ContactDetailsInput;
|
|
2322
|
+
}
|
|
2323
|
+
interface EmailOrgSettingsUpdate {
|
|
2324
|
+
dailyVolume?: number;
|
|
2325
|
+
physicalAddress?: string;
|
|
2326
|
+
}
|
|
2327
|
+
interface AddPersonaRequest {
|
|
2328
|
+
firstName: string;
|
|
2329
|
+
lastName: string;
|
|
2330
|
+
title?: string;
|
|
2331
|
+
}
|
|
2332
|
+
interface AddOrgMemberRequest {
|
|
2333
|
+
email: string;
|
|
2334
|
+
role?: string;
|
|
2335
|
+
}
|
|
2336
|
+
interface EmailOnboardResponse {
|
|
2337
|
+
organizationId: string;
|
|
2338
|
+
status: string;
|
|
2339
|
+
message: string;
|
|
2340
|
+
}
|
|
2341
|
+
interface EmailOnboardStatusResponse {
|
|
2342
|
+
organizationId: string;
|
|
2343
|
+
organizationName: string;
|
|
2344
|
+
phase: string;
|
|
2345
|
+
domains: Record<string, number>;
|
|
2346
|
+
mailboxes: Record<string, number>;
|
|
2347
|
+
estimatedReadyAt?: string | null;
|
|
2348
|
+
}
|
|
2349
|
+
interface EmailOrgSettingsResponse {
|
|
2350
|
+
organizationId: string;
|
|
2351
|
+
organizationName: string;
|
|
2352
|
+
dailyVolume: number;
|
|
2353
|
+
volumeMode: string;
|
|
2354
|
+
physicalAddress?: string | null;
|
|
2355
|
+
senderPersonas: Array<Record<string, unknown>>;
|
|
2356
|
+
domainsActive: number;
|
|
2357
|
+
mailboxesReady: number;
|
|
2358
|
+
}
|
|
2359
|
+
interface EmailOrgHealthResponse {
|
|
2360
|
+
organizationId: string;
|
|
2361
|
+
domains: Record<string, number>;
|
|
2362
|
+
mailboxes: Record<string, number>;
|
|
2363
|
+
sendsToday: number;
|
|
2364
|
+
dailyCapacity: number;
|
|
2365
|
+
}
|
|
2366
|
+
interface EmailOrgSummary {
|
|
2367
|
+
id: string;
|
|
2368
|
+
name: string;
|
|
2369
|
+
role: string;
|
|
2370
|
+
phase: string;
|
|
2371
|
+
domainsActive: number;
|
|
2372
|
+
mailboxesReady: number;
|
|
2373
|
+
}
|
|
2374
|
+
interface EmailOrgListResponse {
|
|
2375
|
+
organizations: EmailOrgSummary[];
|
|
2376
|
+
}
|
|
2377
|
+
interface AddPersonaResponse {
|
|
2378
|
+
personaId: string;
|
|
2379
|
+
message: string;
|
|
2380
|
+
}
|
|
2381
|
+
interface AddOrgMemberResponse {
|
|
2382
|
+
message: string;
|
|
2383
|
+
}
|
|
2384
|
+
interface RemoveOrgMemberResponse {
|
|
2385
|
+
message: string;
|
|
2386
|
+
}
|
|
2387
|
+
interface TeardownOrgResponse {
|
|
2388
|
+
message: string;
|
|
2389
|
+
}
|
|
2390
|
+
|
|
2391
|
+
/**
|
|
2392
|
+
* Resource for managing email infrastructure.
|
|
2393
|
+
*
|
|
2394
|
+
* Handles onboarding, organization management, sender personas,
|
|
2395
|
+
* and member access for email outreach infrastructure.
|
|
2396
|
+
*/
|
|
2397
|
+
declare class EmailResource {
|
|
2398
|
+
private readonly http;
|
|
2399
|
+
constructor(http: Http);
|
|
2400
|
+
/**
|
|
2401
|
+
* Start onboarding a new organization for email outreach.
|
|
2402
|
+
*
|
|
2403
|
+
* This provisions domains, mailboxes, and warmup infrastructure.
|
|
2404
|
+
* Typically takes 30-60 minutes to complete.
|
|
2405
|
+
*/
|
|
2406
|
+
onboard(request: EmailOnboardRequest): Promise<EmailOnboardResponse>;
|
|
2407
|
+
/**
|
|
2408
|
+
* List email organizations the user has access to.
|
|
2409
|
+
*/
|
|
2410
|
+
listOrganizations(userId: string): Promise<EmailOrgListResponse>;
|
|
2411
|
+
/**
|
|
2412
|
+
* Get onboarding status for an organization.
|
|
2413
|
+
*/
|
|
2414
|
+
getOnboardingStatus(orgId: string, userId: string): Promise<EmailOnboardStatusResponse>;
|
|
2415
|
+
/**
|
|
2416
|
+
* Get current settings for an organization.
|
|
2417
|
+
*/
|
|
2418
|
+
getSettings(orgId: string, userId: string): Promise<EmailOrgSettingsResponse>;
|
|
2419
|
+
/**
|
|
2420
|
+
* Update organization settings. Requires admin role.
|
|
2421
|
+
*/
|
|
2422
|
+
updateSettings(orgId: string, userId: string, update: EmailOrgSettingsUpdate): Promise<EmailOrgSettingsResponse>;
|
|
2423
|
+
/**
|
|
2424
|
+
* Get health summary for an organization.
|
|
2425
|
+
*/
|
|
2426
|
+
getHealth(orgId: string, userId: string): Promise<EmailOrgHealthResponse>;
|
|
2427
|
+
/**
|
|
2428
|
+
* Add a new sender persona to an organization.
|
|
2429
|
+
* Provisions mailboxes on existing domains. Requires admin role.
|
|
2430
|
+
*/
|
|
2431
|
+
addPersona(orgId: string, userId: string, persona: AddPersonaRequest): Promise<AddPersonaResponse>;
|
|
2432
|
+
/**
|
|
2433
|
+
* Teardown an email organization's infrastructure.
|
|
2434
|
+
*
|
|
2435
|
+
* Full decommission: cancels warmup, InfraGuard, and mailboxes.
|
|
2436
|
+
* Requires admin role on the org.
|
|
2437
|
+
*/
|
|
2438
|
+
teardown(orgId: string, userId: string): Promise<TeardownOrgResponse>;
|
|
2439
|
+
/**
|
|
2440
|
+
* Add a user to an organization. Requires admin role.
|
|
2441
|
+
*/
|
|
2442
|
+
addMember(orgId: string, userId: string, member: AddOrgMemberRequest): Promise<AddOrgMemberResponse>;
|
|
2443
|
+
/**
|
|
2444
|
+
* Remove a user from an organization. Requires admin role.
|
|
2445
|
+
*/
|
|
2446
|
+
removeMember(orgId: string, userId: string, memberEmail: string): Promise<RemoveOrgMemberResponse>;
|
|
2447
|
+
}
|
|
2448
|
+
|
|
2268
2449
|
/** Input for one person to enrich */
|
|
2269
2450
|
interface ContactEnrichPersonInput {
|
|
2270
2451
|
linkedinUrl?: string | null;
|
|
@@ -4353,6 +4534,7 @@ declare class ResponsesResource {
|
|
|
4353
4534
|
* @param options.excludeProfiles - LinkedIn URLs to exclude from results
|
|
4354
4535
|
* @param options.excludePreviouslyContacted - Exclude previously contacted people
|
|
4355
4536
|
* @param options.excludeNames - Names to exclude from results
|
|
4537
|
+
* @param options.searchJobSignal - CrustData job-listing signal search (decision makers at hiring companies); true | false | 'auto'
|
|
4356
4538
|
* @returns Response with structured_response containing:
|
|
4357
4539
|
* - candidates: Validated and scored candidates
|
|
4358
4540
|
* - criteria: Generated/reused criteria definitions and classification
|
|
@@ -4388,6 +4570,7 @@ declare class ResponsesResource {
|
|
|
4388
4570
|
postsEnableFiltering?: boolean;
|
|
4389
4571
|
engagementScoreWeight?: number;
|
|
4390
4572
|
postsExtractAuthor?: boolean;
|
|
4573
|
+
searchJobSignal?: boolean | 'auto';
|
|
4391
4574
|
}): Promise<CreateResponseResponse>;
|
|
4392
4575
|
/**
|
|
4393
4576
|
* Score provided candidates against AI-generated or provided criteria
|
|
@@ -5564,6 +5747,7 @@ declare class LumnisClient {
|
|
|
5564
5747
|
readonly campaigns: CampaignsResource;
|
|
5565
5748
|
readonly contactRelationships: ContactRelationshipsResource;
|
|
5566
5749
|
readonly enrichment: EnrichmentResource;
|
|
5750
|
+
readonly email: EmailResource;
|
|
5567
5751
|
private readonly _scopedUserId?;
|
|
5568
5752
|
private readonly _defaultScope;
|
|
5569
5753
|
constructor(options?: LumnisClientOptions);
|
|
@@ -5916,4 +6100,4 @@ declare class ProgressTracker {
|
|
|
5916
6100
|
*/
|
|
5917
6101
|
declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
|
|
5918
6102
|
|
|
5919
|
-
export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, 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 ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsSyncStatus, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, 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, 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 DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailThreadSummary, 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 InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, 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 ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListExecutionsOptions, 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 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 OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, type PaginationInfo, type PaginationParams, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, 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 ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, SEQUENCE_RATE_LIMITS, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, 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, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, 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 TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, 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 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 };
|
|
6103
|
+
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 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 ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type ContactHistorySyncStatus, type ContactRelationshipProvider, type ContactRelationshipResponse, type ContactRelationshipStatus, ContactRelationshipsResource, type ContactScore, 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, 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 DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailThreadSummary, 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 InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, 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 ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListExecutionsOptions, 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 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 OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, type PaginationInfo, type PaginationParams, type PauseResumeQueuedRequest, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, type PlaybookCreate, type PlaybookGenerateJobResponse, type PlaybookGenerateJobStatusResponse, type PlaybookGenerateRequest, type PlaybookResponse, type PlaybookUpdate, type PlaybookVersionResponse, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, 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 RemoveOrgMemberResponse, type ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, 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, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, 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 TeardownOrgResponse, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, 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 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
|
@@ -916,6 +916,114 @@ class ContactRelationshipsResource {
|
|
|
916
916
|
}
|
|
917
917
|
}
|
|
918
918
|
|
|
919
|
+
class EmailResource {
|
|
920
|
+
constructor(http) {
|
|
921
|
+
this.http = http;
|
|
922
|
+
}
|
|
923
|
+
// ==================== Onboarding ====================
|
|
924
|
+
/**
|
|
925
|
+
* Start onboarding a new organization for email outreach.
|
|
926
|
+
*
|
|
927
|
+
* This provisions domains, mailboxes, and warmup infrastructure.
|
|
928
|
+
* Typically takes 30-60 minutes to complete.
|
|
929
|
+
*/
|
|
930
|
+
async onboard(request) {
|
|
931
|
+
return this.http.post("/email/onboard", request);
|
|
932
|
+
}
|
|
933
|
+
// ==================== Organizations ====================
|
|
934
|
+
/**
|
|
935
|
+
* List email organizations the user has access to.
|
|
936
|
+
*/
|
|
937
|
+
async listOrganizations(userId) {
|
|
938
|
+
return this.http.get("/email/organizations", {
|
|
939
|
+
params: { user_id: userId }
|
|
940
|
+
});
|
|
941
|
+
}
|
|
942
|
+
/**
|
|
943
|
+
* Get onboarding status for an organization.
|
|
944
|
+
*/
|
|
945
|
+
async getOnboardingStatus(orgId, userId) {
|
|
946
|
+
return this.http.get(
|
|
947
|
+
`/email/organizations/${encodeURIComponent(orgId)}/status`,
|
|
948
|
+
{ params: { user_id: userId } }
|
|
949
|
+
);
|
|
950
|
+
}
|
|
951
|
+
/**
|
|
952
|
+
* Get current settings for an organization.
|
|
953
|
+
*/
|
|
954
|
+
async getSettings(orgId, userId) {
|
|
955
|
+
return this.http.get(
|
|
956
|
+
`/email/organizations/${encodeURIComponent(orgId)}/settings`,
|
|
957
|
+
{ params: { user_id: userId } }
|
|
958
|
+
);
|
|
959
|
+
}
|
|
960
|
+
/**
|
|
961
|
+
* Update organization settings. Requires admin role.
|
|
962
|
+
*/
|
|
963
|
+
async updateSettings(orgId, userId, update) {
|
|
964
|
+
return this.http.put(
|
|
965
|
+
`/email/organizations/${encodeURIComponent(orgId)}/settings`,
|
|
966
|
+
update,
|
|
967
|
+
{ params: { user_id: userId } }
|
|
968
|
+
);
|
|
969
|
+
}
|
|
970
|
+
/**
|
|
971
|
+
* Get health summary for an organization.
|
|
972
|
+
*/
|
|
973
|
+
async getHealth(orgId, userId) {
|
|
974
|
+
return this.http.get(
|
|
975
|
+
`/email/organizations/${encodeURIComponent(orgId)}/health`,
|
|
976
|
+
{ params: { user_id: userId } }
|
|
977
|
+
);
|
|
978
|
+
}
|
|
979
|
+
// ==================== Personas ====================
|
|
980
|
+
/**
|
|
981
|
+
* Add a new sender persona to an organization.
|
|
982
|
+
* Provisions mailboxes on existing domains. Requires admin role.
|
|
983
|
+
*/
|
|
984
|
+
async addPersona(orgId, userId, persona) {
|
|
985
|
+
return this.http.post(
|
|
986
|
+
`/email/organizations/${encodeURIComponent(orgId)}/personas`,
|
|
987
|
+
persona,
|
|
988
|
+
{ params: { user_id: userId } }
|
|
989
|
+
);
|
|
990
|
+
}
|
|
991
|
+
// ==================== Teardown ====================
|
|
992
|
+
/**
|
|
993
|
+
* Teardown an email organization's infrastructure.
|
|
994
|
+
*
|
|
995
|
+
* Full decommission: cancels warmup, InfraGuard, and mailboxes.
|
|
996
|
+
* Requires admin role on the org.
|
|
997
|
+
*/
|
|
998
|
+
async teardown(orgId, userId) {
|
|
999
|
+
return this.http.post(
|
|
1000
|
+
`/email/organizations/${encodeURIComponent(orgId)}/teardown`,
|
|
1001
|
+
{},
|
|
1002
|
+
{ params: { user_id: userId } }
|
|
1003
|
+
);
|
|
1004
|
+
}
|
|
1005
|
+
// ==================== Members ====================
|
|
1006
|
+
/**
|
|
1007
|
+
* Add a user to an organization. Requires admin role.
|
|
1008
|
+
*/
|
|
1009
|
+
async addMember(orgId, userId, member) {
|
|
1010
|
+
return this.http.post(
|
|
1011
|
+
`/email/organizations/${encodeURIComponent(orgId)}/members`,
|
|
1012
|
+
member,
|
|
1013
|
+
{ params: { user_id: userId } }
|
|
1014
|
+
);
|
|
1015
|
+
}
|
|
1016
|
+
/**
|
|
1017
|
+
* Remove a user from an organization. Requires admin role.
|
|
1018
|
+
*/
|
|
1019
|
+
async removeMember(orgId, userId, memberEmail) {
|
|
1020
|
+
return this.http.delete(
|
|
1021
|
+
`/email/organizations/${encodeURIComponent(orgId)}/members/${encodeURIComponent(memberEmail)}`,
|
|
1022
|
+
{ params: { user_id: userId } }
|
|
1023
|
+
);
|
|
1024
|
+
}
|
|
1025
|
+
}
|
|
1026
|
+
|
|
919
1027
|
class EnrichmentResource {
|
|
920
1028
|
constructor(http) {
|
|
921
1029
|
this.http = http;
|
|
@@ -3113,6 +3221,7 @@ class ResponsesResource {
|
|
|
3113
3221
|
* @param options.excludeProfiles - LinkedIn URLs to exclude from results
|
|
3114
3222
|
* @param options.excludePreviouslyContacted - Exclude previously contacted people
|
|
3115
3223
|
* @param options.excludeNames - Names to exclude from results
|
|
3224
|
+
* @param options.searchJobSignal - CrustData job-listing signal search (decision makers at hiring companies); true | false | 'auto'
|
|
3116
3225
|
* @returns Response with structured_response containing:
|
|
3117
3226
|
* - candidates: Validated and scored candidates
|
|
3118
3227
|
* - criteria: Generated/reused criteria definitions and classification
|
|
@@ -3173,6 +3282,8 @@ class ResponsesResource {
|
|
|
3173
3282
|
params.engagementScoreWeight = options.engagementScoreWeight;
|
|
3174
3283
|
if (options.postsExtractAuthor !== void 0)
|
|
3175
3284
|
params.postsExtractAuthor = options.postsExtractAuthor;
|
|
3285
|
+
if (options.searchJobSignal !== void 0)
|
|
3286
|
+
params.searchJobSignal = options.searchJobSignal;
|
|
3176
3287
|
if (Object.keys(params).length > 0)
|
|
3177
3288
|
request.specializedAgentParams = params;
|
|
3178
3289
|
}
|
|
@@ -4156,6 +4267,7 @@ class LumnisClient {
|
|
|
4156
4267
|
campaigns;
|
|
4157
4268
|
contactRelationships;
|
|
4158
4269
|
enrichment;
|
|
4270
|
+
email;
|
|
4159
4271
|
_scopedUserId;
|
|
4160
4272
|
_defaultScope;
|
|
4161
4273
|
constructor(options = {}) {
|
|
@@ -4192,6 +4304,7 @@ class LumnisClient {
|
|
|
4192
4304
|
this.campaigns = new CampaignsResource(this.http);
|
|
4193
4305
|
this.contactRelationships = new ContactRelationshipsResource(this.http);
|
|
4194
4306
|
this.enrichment = new EnrichmentResource(this.http);
|
|
4307
|
+
this.email = new EmailResource(this.http);
|
|
4195
4308
|
}
|
|
4196
4309
|
forUser(userId) {
|
|
4197
4310
|
return new LumnisClient({
|