lumnisai 0.5.13 → 0.5.15

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 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;
@@ -4162,6 +4270,7 @@ class LumnisClient {
4162
4270
  campaigns;
4163
4271
  contactRelationships;
4164
4272
  enrichment;
4273
+ email;
4165
4274
  _scopedUserId;
4166
4275
  _defaultScope;
4167
4276
  constructor(options = {}) {
@@ -4198,6 +4307,7 @@ class LumnisClient {
4198
4307
  this.campaigns = new CampaignsResource(this.http);
4199
4308
  this.contactRelationships = new ContactRelationshipsResource(this.http);
4200
4309
  this.enrichment = new EnrichmentResource(this.http);
4310
+ this.email = new EmailResource(this.http);
4201
4311
  }
4202
4312
  forUser(userId) {
4203
4313
  return new LumnisClient({
package/dist/index.d.cts CHANGED
@@ -1651,6 +1651,9 @@ interface ApprovalSettings {
1651
1651
  sendFollowUpLinkedin?: ApprovalMode;
1652
1652
  sendInmailLinkedin?: ApprovalMode;
1653
1653
  replyLinkedin?: ApprovalMode;
1654
+ sendInitialEmail?: ApprovalMode;
1655
+ sendFollowUpEmail?: ApprovalMode;
1656
+ replyEmail?: ApprovalMode;
1654
1657
  stop?: ApprovalMode;
1655
1658
  }
1656
1659
  interface PlaybookCreate {
@@ -1711,6 +1714,7 @@ interface CampaignCreate {
1711
1714
  guardrails?: CampaignGuardrails;
1712
1715
  approvalSettings?: ApprovalSettings;
1713
1716
  maxProspects?: number;
1717
+ emailPersonaId?: string;
1714
1718
  }
1715
1719
  interface CampaignUpdate {
1716
1720
  name?: string;
@@ -1721,6 +1725,7 @@ interface CampaignUpdate {
1721
1725
  guardrails?: CampaignGuardrails;
1722
1726
  approvalSettings?: ApprovalSettings;
1723
1727
  maxProspects?: number;
1728
+ emailPersonaId?: string;
1724
1729
  }
1725
1730
  interface CampaignResponse {
1726
1731
  id: string;
@@ -1737,6 +1742,7 @@ interface CampaignResponse {
1737
1742
  status: CampaignStatus;
1738
1743
  approvalSettings: ApprovalSettings;
1739
1744
  maxProspects?: number | null;
1745
+ emailPersonaId?: string | null;
1740
1746
  startedAt?: string | null;
1741
1747
  pausedAt?: string | null;
1742
1748
  terminalProspectCount: number;
@@ -1781,6 +1787,7 @@ interface CampaignProspectResponse {
1781
1787
  lastActionType?: string | null;
1782
1788
  followUpCount: number;
1783
1789
  senderAccountId?: string | null;
1790
+ senderMailboxId?: string | null;
1784
1791
  pendingActionId?: string | null;
1785
1792
  previousState?: string | null;
1786
1793
  snoozedUntil?: string | null;
@@ -1792,7 +1799,7 @@ interface CampaignProspectResponse {
1792
1799
  createdAt: string;
1793
1800
  updatedAt: string;
1794
1801
  }
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';
1802
+ 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
1803
  type CampaignActionStatus = 'pending_approval' | 'approved' | 'edited' | 'skipped' | 'auto_approved' | 'queued' | 'executed' | 'failed' | 'cancelled' | 'cancelled_by_pause' | 'paused';
1797
1804
  interface CampaignActionResponse {
1798
1805
  id: string;
@@ -1898,9 +1905,11 @@ interface StoppedBreakdown {
1898
1905
  }
1899
1906
  interface CampaignMetricsResponse {
1900
1907
  totalProspects: number;
1908
+ activeProspects: number;
1901
1909
  funnel: Record<string, FunnelStage>;
1902
1910
  stopped: StoppedBreakdown;
1903
1911
  pendingApproval: number;
1912
+ rateLimited: Record<string, number>;
1904
1913
  actionSummary: Record<string, number>;
1905
1914
  actionTypes: Record<string, Record<string, number>>;
1906
1915
  }
@@ -2263,6 +2272,165 @@ declare class ContactRelationshipsResource {
2263
2272
  get(options: GetContactRelationshipsOptions): Promise<ContactRelationshipResponse>;
2264
2273
  }
2265
2274
 
2275
+ /**
2276
+ * Email infrastructure types.
2277
+ *
2278
+ * These types map to the Python backend endpoints under /v1/email.
2279
+ */
2280
+ interface SenderPersonaInput {
2281
+ firstName: string;
2282
+ lastName: string;
2283
+ title?: string;
2284
+ }
2285
+ interface ContactDetailsInput {
2286
+ firstName: string;
2287
+ lastName: string;
2288
+ email: string;
2289
+ phone: string;
2290
+ organization: string;
2291
+ addressLine1: string;
2292
+ city: string;
2293
+ state: string;
2294
+ country: string;
2295
+ postalCode: string;
2296
+ }
2297
+ interface EmailOnboardRequest {
2298
+ userId: string;
2299
+ organizationName: string;
2300
+ primaryWebsiteUrl: string;
2301
+ companyDescription?: string;
2302
+ physicalAddress: string;
2303
+ dailyVolume: number;
2304
+ volumeMode?: string;
2305
+ senderPersonas: SenderPersonaInput[];
2306
+ contactDetails: ContactDetailsInput;
2307
+ }
2308
+ interface EmailOrgSettingsUpdate {
2309
+ dailyVolume?: number;
2310
+ physicalAddress?: string;
2311
+ }
2312
+ interface AddPersonaRequest {
2313
+ firstName: string;
2314
+ lastName: string;
2315
+ title?: string;
2316
+ }
2317
+ interface AddOrgMemberRequest {
2318
+ email: string;
2319
+ role?: string;
2320
+ }
2321
+ interface EmailOnboardResponse {
2322
+ organizationId: string;
2323
+ status: string;
2324
+ message: string;
2325
+ }
2326
+ interface EmailOnboardStatusResponse {
2327
+ organizationId: string;
2328
+ organizationName: string;
2329
+ phase: string;
2330
+ domains: Record<string, number>;
2331
+ mailboxes: Record<string, number>;
2332
+ estimatedReadyAt?: string | null;
2333
+ }
2334
+ interface EmailOrgSettingsResponse {
2335
+ organizationId: string;
2336
+ organizationName: string;
2337
+ dailyVolume: number;
2338
+ volumeMode: string;
2339
+ physicalAddress?: string | null;
2340
+ senderPersonas: Array<Record<string, unknown>>;
2341
+ domainsActive: number;
2342
+ mailboxesReady: number;
2343
+ }
2344
+ interface EmailOrgHealthResponse {
2345
+ organizationId: string;
2346
+ domains: Record<string, number>;
2347
+ mailboxes: Record<string, number>;
2348
+ sendsToday: number;
2349
+ dailyCapacity: number;
2350
+ }
2351
+ interface EmailOrgSummary {
2352
+ id: string;
2353
+ name: string;
2354
+ role: string;
2355
+ phase: string;
2356
+ domainsActive: number;
2357
+ mailboxesReady: number;
2358
+ }
2359
+ interface EmailOrgListResponse {
2360
+ organizations: EmailOrgSummary[];
2361
+ }
2362
+ interface AddPersonaResponse {
2363
+ personaId: string;
2364
+ message: string;
2365
+ }
2366
+ interface AddOrgMemberResponse {
2367
+ message: string;
2368
+ }
2369
+ interface RemoveOrgMemberResponse {
2370
+ message: string;
2371
+ }
2372
+ interface TeardownOrgResponse {
2373
+ message: string;
2374
+ }
2375
+
2376
+ /**
2377
+ * Resource for managing email infrastructure.
2378
+ *
2379
+ * Handles onboarding, organization management, sender personas,
2380
+ * and member access for email outreach infrastructure.
2381
+ */
2382
+ declare class EmailResource {
2383
+ private readonly http;
2384
+ constructor(http: Http);
2385
+ /**
2386
+ * Start onboarding a new organization for email outreach.
2387
+ *
2388
+ * This provisions domains, mailboxes, and warmup infrastructure.
2389
+ * Typically takes 30-60 minutes to complete.
2390
+ */
2391
+ onboard(request: EmailOnboardRequest): Promise<EmailOnboardResponse>;
2392
+ /**
2393
+ * List email organizations the user has access to.
2394
+ */
2395
+ listOrganizations(userId: string): Promise<EmailOrgListResponse>;
2396
+ /**
2397
+ * Get onboarding status for an organization.
2398
+ */
2399
+ getOnboardingStatus(orgId: string, userId: string): Promise<EmailOnboardStatusResponse>;
2400
+ /**
2401
+ * Get current settings for an organization.
2402
+ */
2403
+ getSettings(orgId: string, userId: string): Promise<EmailOrgSettingsResponse>;
2404
+ /**
2405
+ * Update organization settings. Requires admin role.
2406
+ */
2407
+ updateSettings(orgId: string, userId: string, update: EmailOrgSettingsUpdate): Promise<EmailOrgSettingsResponse>;
2408
+ /**
2409
+ * Get health summary for an organization.
2410
+ */
2411
+ getHealth(orgId: string, userId: string): Promise<EmailOrgHealthResponse>;
2412
+ /**
2413
+ * Add a new sender persona to an organization.
2414
+ * Provisions mailboxes on existing domains. Requires admin role.
2415
+ */
2416
+ addPersona(orgId: string, userId: string, persona: AddPersonaRequest): Promise<AddPersonaResponse>;
2417
+ /**
2418
+ * Teardown an email organization's infrastructure.
2419
+ *
2420
+ * Full decommission: cancels warmup, InfraGuard, and mailboxes.
2421
+ * Requires admin role on the org.
2422
+ */
2423
+ teardown(orgId: string, userId: string): Promise<TeardownOrgResponse>;
2424
+ /**
2425
+ * Add a user to an organization. Requires admin role.
2426
+ */
2427
+ addMember(orgId: string, userId: string, member: AddOrgMemberRequest): Promise<AddOrgMemberResponse>;
2428
+ /**
2429
+ * Remove a user from an organization. Requires admin role.
2430
+ */
2431
+ removeMember(orgId: string, userId: string, memberEmail: string): Promise<RemoveOrgMemberResponse>;
2432
+ }
2433
+
2266
2434
  /** Input for one person to enrich */
2267
2435
  interface ContactEnrichPersonInput {
2268
2436
  linkedinUrl?: string | null;
@@ -5562,6 +5730,7 @@ declare class LumnisClient {
5562
5730
  readonly campaigns: CampaignsResource;
5563
5731
  readonly contactRelationships: ContactRelationshipsResource;
5564
5732
  readonly enrichment: EnrichmentResource;
5733
+ readonly email: EmailResource;
5565
5734
  private readonly _scopedUserId?;
5566
5735
  private readonly _defaultScope;
5567
5736
  constructor(options?: LumnisClientOptions);
@@ -5914,4 +6083,4 @@ declare class ProgressTracker {
5914
6083
  */
5915
6084
  declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
5916
6085
 
5917
- 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 };
6086
+ 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
@@ -1651,6 +1651,9 @@ interface ApprovalSettings {
1651
1651
  sendFollowUpLinkedin?: ApprovalMode;
1652
1652
  sendInmailLinkedin?: ApprovalMode;
1653
1653
  replyLinkedin?: ApprovalMode;
1654
+ sendInitialEmail?: ApprovalMode;
1655
+ sendFollowUpEmail?: ApprovalMode;
1656
+ replyEmail?: ApprovalMode;
1654
1657
  stop?: ApprovalMode;
1655
1658
  }
1656
1659
  interface PlaybookCreate {
@@ -1711,6 +1714,7 @@ interface CampaignCreate {
1711
1714
  guardrails?: CampaignGuardrails;
1712
1715
  approvalSettings?: ApprovalSettings;
1713
1716
  maxProspects?: number;
1717
+ emailPersonaId?: string;
1714
1718
  }
1715
1719
  interface CampaignUpdate {
1716
1720
  name?: string;
@@ -1721,6 +1725,7 @@ interface CampaignUpdate {
1721
1725
  guardrails?: CampaignGuardrails;
1722
1726
  approvalSettings?: ApprovalSettings;
1723
1727
  maxProspects?: number;
1728
+ emailPersonaId?: string;
1724
1729
  }
1725
1730
  interface CampaignResponse {
1726
1731
  id: string;
@@ -1737,6 +1742,7 @@ interface CampaignResponse {
1737
1742
  status: CampaignStatus;
1738
1743
  approvalSettings: ApprovalSettings;
1739
1744
  maxProspects?: number | null;
1745
+ emailPersonaId?: string | null;
1740
1746
  startedAt?: string | null;
1741
1747
  pausedAt?: string | null;
1742
1748
  terminalProspectCount: number;
@@ -1781,6 +1787,7 @@ interface CampaignProspectResponse {
1781
1787
  lastActionType?: string | null;
1782
1788
  followUpCount: number;
1783
1789
  senderAccountId?: string | null;
1790
+ senderMailboxId?: string | null;
1784
1791
  pendingActionId?: string | null;
1785
1792
  previousState?: string | null;
1786
1793
  snoozedUntil?: string | null;
@@ -1792,7 +1799,7 @@ interface CampaignProspectResponse {
1792
1799
  createdAt: string;
1793
1800
  updatedAt: string;
1794
1801
  }
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';
1802
+ 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
1803
  type CampaignActionStatus = 'pending_approval' | 'approved' | 'edited' | 'skipped' | 'auto_approved' | 'queued' | 'executed' | 'failed' | 'cancelled' | 'cancelled_by_pause' | 'paused';
1797
1804
  interface CampaignActionResponse {
1798
1805
  id: string;
@@ -1898,9 +1905,11 @@ interface StoppedBreakdown {
1898
1905
  }
1899
1906
  interface CampaignMetricsResponse {
1900
1907
  totalProspects: number;
1908
+ activeProspects: number;
1901
1909
  funnel: Record<string, FunnelStage>;
1902
1910
  stopped: StoppedBreakdown;
1903
1911
  pendingApproval: number;
1912
+ rateLimited: Record<string, number>;
1904
1913
  actionSummary: Record<string, number>;
1905
1914
  actionTypes: Record<string, Record<string, number>>;
1906
1915
  }
@@ -2263,6 +2272,165 @@ declare class ContactRelationshipsResource {
2263
2272
  get(options: GetContactRelationshipsOptions): Promise<ContactRelationshipResponse>;
2264
2273
  }
2265
2274
 
2275
+ /**
2276
+ * Email infrastructure types.
2277
+ *
2278
+ * These types map to the Python backend endpoints under /v1/email.
2279
+ */
2280
+ interface SenderPersonaInput {
2281
+ firstName: string;
2282
+ lastName: string;
2283
+ title?: string;
2284
+ }
2285
+ interface ContactDetailsInput {
2286
+ firstName: string;
2287
+ lastName: string;
2288
+ email: string;
2289
+ phone: string;
2290
+ organization: string;
2291
+ addressLine1: string;
2292
+ city: string;
2293
+ state: string;
2294
+ country: string;
2295
+ postalCode: string;
2296
+ }
2297
+ interface EmailOnboardRequest {
2298
+ userId: string;
2299
+ organizationName: string;
2300
+ primaryWebsiteUrl: string;
2301
+ companyDescription?: string;
2302
+ physicalAddress: string;
2303
+ dailyVolume: number;
2304
+ volumeMode?: string;
2305
+ senderPersonas: SenderPersonaInput[];
2306
+ contactDetails: ContactDetailsInput;
2307
+ }
2308
+ interface EmailOrgSettingsUpdate {
2309
+ dailyVolume?: number;
2310
+ physicalAddress?: string;
2311
+ }
2312
+ interface AddPersonaRequest {
2313
+ firstName: string;
2314
+ lastName: string;
2315
+ title?: string;
2316
+ }
2317
+ interface AddOrgMemberRequest {
2318
+ email: string;
2319
+ role?: string;
2320
+ }
2321
+ interface EmailOnboardResponse {
2322
+ organizationId: string;
2323
+ status: string;
2324
+ message: string;
2325
+ }
2326
+ interface EmailOnboardStatusResponse {
2327
+ organizationId: string;
2328
+ organizationName: string;
2329
+ phase: string;
2330
+ domains: Record<string, number>;
2331
+ mailboxes: Record<string, number>;
2332
+ estimatedReadyAt?: string | null;
2333
+ }
2334
+ interface EmailOrgSettingsResponse {
2335
+ organizationId: string;
2336
+ organizationName: string;
2337
+ dailyVolume: number;
2338
+ volumeMode: string;
2339
+ physicalAddress?: string | null;
2340
+ senderPersonas: Array<Record<string, unknown>>;
2341
+ domainsActive: number;
2342
+ mailboxesReady: number;
2343
+ }
2344
+ interface EmailOrgHealthResponse {
2345
+ organizationId: string;
2346
+ domains: Record<string, number>;
2347
+ mailboxes: Record<string, number>;
2348
+ sendsToday: number;
2349
+ dailyCapacity: number;
2350
+ }
2351
+ interface EmailOrgSummary {
2352
+ id: string;
2353
+ name: string;
2354
+ role: string;
2355
+ phase: string;
2356
+ domainsActive: number;
2357
+ mailboxesReady: number;
2358
+ }
2359
+ interface EmailOrgListResponse {
2360
+ organizations: EmailOrgSummary[];
2361
+ }
2362
+ interface AddPersonaResponse {
2363
+ personaId: string;
2364
+ message: string;
2365
+ }
2366
+ interface AddOrgMemberResponse {
2367
+ message: string;
2368
+ }
2369
+ interface RemoveOrgMemberResponse {
2370
+ message: string;
2371
+ }
2372
+ interface TeardownOrgResponse {
2373
+ message: string;
2374
+ }
2375
+
2376
+ /**
2377
+ * Resource for managing email infrastructure.
2378
+ *
2379
+ * Handles onboarding, organization management, sender personas,
2380
+ * and member access for email outreach infrastructure.
2381
+ */
2382
+ declare class EmailResource {
2383
+ private readonly http;
2384
+ constructor(http: Http);
2385
+ /**
2386
+ * Start onboarding a new organization for email outreach.
2387
+ *
2388
+ * This provisions domains, mailboxes, and warmup infrastructure.
2389
+ * Typically takes 30-60 minutes to complete.
2390
+ */
2391
+ onboard(request: EmailOnboardRequest): Promise<EmailOnboardResponse>;
2392
+ /**
2393
+ * List email organizations the user has access to.
2394
+ */
2395
+ listOrganizations(userId: string): Promise<EmailOrgListResponse>;
2396
+ /**
2397
+ * Get onboarding status for an organization.
2398
+ */
2399
+ getOnboardingStatus(orgId: string, userId: string): Promise<EmailOnboardStatusResponse>;
2400
+ /**
2401
+ * Get current settings for an organization.
2402
+ */
2403
+ getSettings(orgId: string, userId: string): Promise<EmailOrgSettingsResponse>;
2404
+ /**
2405
+ * Update organization settings. Requires admin role.
2406
+ */
2407
+ updateSettings(orgId: string, userId: string, update: EmailOrgSettingsUpdate): Promise<EmailOrgSettingsResponse>;
2408
+ /**
2409
+ * Get health summary for an organization.
2410
+ */
2411
+ getHealth(orgId: string, userId: string): Promise<EmailOrgHealthResponse>;
2412
+ /**
2413
+ * Add a new sender persona to an organization.
2414
+ * Provisions mailboxes on existing domains. Requires admin role.
2415
+ */
2416
+ addPersona(orgId: string, userId: string, persona: AddPersonaRequest): Promise<AddPersonaResponse>;
2417
+ /**
2418
+ * Teardown an email organization's infrastructure.
2419
+ *
2420
+ * Full decommission: cancels warmup, InfraGuard, and mailboxes.
2421
+ * Requires admin role on the org.
2422
+ */
2423
+ teardown(orgId: string, userId: string): Promise<TeardownOrgResponse>;
2424
+ /**
2425
+ * Add a user to an organization. Requires admin role.
2426
+ */
2427
+ addMember(orgId: string, userId: string, member: AddOrgMemberRequest): Promise<AddOrgMemberResponse>;
2428
+ /**
2429
+ * Remove a user from an organization. Requires admin role.
2430
+ */
2431
+ removeMember(orgId: string, userId: string, memberEmail: string): Promise<RemoveOrgMemberResponse>;
2432
+ }
2433
+
2266
2434
  /** Input for one person to enrich */
2267
2435
  interface ContactEnrichPersonInput {
2268
2436
  linkedinUrl?: string | null;
@@ -5562,6 +5730,7 @@ declare class LumnisClient {
5562
5730
  readonly campaigns: CampaignsResource;
5563
5731
  readonly contactRelationships: ContactRelationshipsResource;
5564
5732
  readonly enrichment: EnrichmentResource;
5733
+ readonly email: EmailResource;
5565
5734
  private readonly _scopedUserId?;
5566
5735
  private readonly _defaultScope;
5567
5736
  constructor(options?: LumnisClientOptions);
@@ -5914,4 +6083,4 @@ declare class ProgressTracker {
5914
6083
  */
5915
6084
  declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
5916
6085
 
5917
- 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 };
6086
+ 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
@@ -1651,6 +1651,9 @@ interface ApprovalSettings {
1651
1651
  sendFollowUpLinkedin?: ApprovalMode;
1652
1652
  sendInmailLinkedin?: ApprovalMode;
1653
1653
  replyLinkedin?: ApprovalMode;
1654
+ sendInitialEmail?: ApprovalMode;
1655
+ sendFollowUpEmail?: ApprovalMode;
1656
+ replyEmail?: ApprovalMode;
1654
1657
  stop?: ApprovalMode;
1655
1658
  }
1656
1659
  interface PlaybookCreate {
@@ -1711,6 +1714,7 @@ interface CampaignCreate {
1711
1714
  guardrails?: CampaignGuardrails;
1712
1715
  approvalSettings?: ApprovalSettings;
1713
1716
  maxProspects?: number;
1717
+ emailPersonaId?: string;
1714
1718
  }
1715
1719
  interface CampaignUpdate {
1716
1720
  name?: string;
@@ -1721,6 +1725,7 @@ interface CampaignUpdate {
1721
1725
  guardrails?: CampaignGuardrails;
1722
1726
  approvalSettings?: ApprovalSettings;
1723
1727
  maxProspects?: number;
1728
+ emailPersonaId?: string;
1724
1729
  }
1725
1730
  interface CampaignResponse {
1726
1731
  id: string;
@@ -1737,6 +1742,7 @@ interface CampaignResponse {
1737
1742
  status: CampaignStatus;
1738
1743
  approvalSettings: ApprovalSettings;
1739
1744
  maxProspects?: number | null;
1745
+ emailPersonaId?: string | null;
1740
1746
  startedAt?: string | null;
1741
1747
  pausedAt?: string | null;
1742
1748
  terminalProspectCount: number;
@@ -1781,6 +1787,7 @@ interface CampaignProspectResponse {
1781
1787
  lastActionType?: string | null;
1782
1788
  followUpCount: number;
1783
1789
  senderAccountId?: string | null;
1790
+ senderMailboxId?: string | null;
1784
1791
  pendingActionId?: string | null;
1785
1792
  previousState?: string | null;
1786
1793
  snoozedUntil?: string | null;
@@ -1792,7 +1799,7 @@ interface CampaignProspectResponse {
1792
1799
  createdAt: string;
1793
1800
  updatedAt: string;
1794
1801
  }
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';
1802
+ 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
1803
  type CampaignActionStatus = 'pending_approval' | 'approved' | 'edited' | 'skipped' | 'auto_approved' | 'queued' | 'executed' | 'failed' | 'cancelled' | 'cancelled_by_pause' | 'paused';
1797
1804
  interface CampaignActionResponse {
1798
1805
  id: string;
@@ -1898,9 +1905,11 @@ interface StoppedBreakdown {
1898
1905
  }
1899
1906
  interface CampaignMetricsResponse {
1900
1907
  totalProspects: number;
1908
+ activeProspects: number;
1901
1909
  funnel: Record<string, FunnelStage>;
1902
1910
  stopped: StoppedBreakdown;
1903
1911
  pendingApproval: number;
1912
+ rateLimited: Record<string, number>;
1904
1913
  actionSummary: Record<string, number>;
1905
1914
  actionTypes: Record<string, Record<string, number>>;
1906
1915
  }
@@ -2263,6 +2272,165 @@ declare class ContactRelationshipsResource {
2263
2272
  get(options: GetContactRelationshipsOptions): Promise<ContactRelationshipResponse>;
2264
2273
  }
2265
2274
 
2275
+ /**
2276
+ * Email infrastructure types.
2277
+ *
2278
+ * These types map to the Python backend endpoints under /v1/email.
2279
+ */
2280
+ interface SenderPersonaInput {
2281
+ firstName: string;
2282
+ lastName: string;
2283
+ title?: string;
2284
+ }
2285
+ interface ContactDetailsInput {
2286
+ firstName: string;
2287
+ lastName: string;
2288
+ email: string;
2289
+ phone: string;
2290
+ organization: string;
2291
+ addressLine1: string;
2292
+ city: string;
2293
+ state: string;
2294
+ country: string;
2295
+ postalCode: string;
2296
+ }
2297
+ interface EmailOnboardRequest {
2298
+ userId: string;
2299
+ organizationName: string;
2300
+ primaryWebsiteUrl: string;
2301
+ companyDescription?: string;
2302
+ physicalAddress: string;
2303
+ dailyVolume: number;
2304
+ volumeMode?: string;
2305
+ senderPersonas: SenderPersonaInput[];
2306
+ contactDetails: ContactDetailsInput;
2307
+ }
2308
+ interface EmailOrgSettingsUpdate {
2309
+ dailyVolume?: number;
2310
+ physicalAddress?: string;
2311
+ }
2312
+ interface AddPersonaRequest {
2313
+ firstName: string;
2314
+ lastName: string;
2315
+ title?: string;
2316
+ }
2317
+ interface AddOrgMemberRequest {
2318
+ email: string;
2319
+ role?: string;
2320
+ }
2321
+ interface EmailOnboardResponse {
2322
+ organizationId: string;
2323
+ status: string;
2324
+ message: string;
2325
+ }
2326
+ interface EmailOnboardStatusResponse {
2327
+ organizationId: string;
2328
+ organizationName: string;
2329
+ phase: string;
2330
+ domains: Record<string, number>;
2331
+ mailboxes: Record<string, number>;
2332
+ estimatedReadyAt?: string | null;
2333
+ }
2334
+ interface EmailOrgSettingsResponse {
2335
+ organizationId: string;
2336
+ organizationName: string;
2337
+ dailyVolume: number;
2338
+ volumeMode: string;
2339
+ physicalAddress?: string | null;
2340
+ senderPersonas: Array<Record<string, unknown>>;
2341
+ domainsActive: number;
2342
+ mailboxesReady: number;
2343
+ }
2344
+ interface EmailOrgHealthResponse {
2345
+ organizationId: string;
2346
+ domains: Record<string, number>;
2347
+ mailboxes: Record<string, number>;
2348
+ sendsToday: number;
2349
+ dailyCapacity: number;
2350
+ }
2351
+ interface EmailOrgSummary {
2352
+ id: string;
2353
+ name: string;
2354
+ role: string;
2355
+ phase: string;
2356
+ domainsActive: number;
2357
+ mailboxesReady: number;
2358
+ }
2359
+ interface EmailOrgListResponse {
2360
+ organizations: EmailOrgSummary[];
2361
+ }
2362
+ interface AddPersonaResponse {
2363
+ personaId: string;
2364
+ message: string;
2365
+ }
2366
+ interface AddOrgMemberResponse {
2367
+ message: string;
2368
+ }
2369
+ interface RemoveOrgMemberResponse {
2370
+ message: string;
2371
+ }
2372
+ interface TeardownOrgResponse {
2373
+ message: string;
2374
+ }
2375
+
2376
+ /**
2377
+ * Resource for managing email infrastructure.
2378
+ *
2379
+ * Handles onboarding, organization management, sender personas,
2380
+ * and member access for email outreach infrastructure.
2381
+ */
2382
+ declare class EmailResource {
2383
+ private readonly http;
2384
+ constructor(http: Http);
2385
+ /**
2386
+ * Start onboarding a new organization for email outreach.
2387
+ *
2388
+ * This provisions domains, mailboxes, and warmup infrastructure.
2389
+ * Typically takes 30-60 minutes to complete.
2390
+ */
2391
+ onboard(request: EmailOnboardRequest): Promise<EmailOnboardResponse>;
2392
+ /**
2393
+ * List email organizations the user has access to.
2394
+ */
2395
+ listOrganizations(userId: string): Promise<EmailOrgListResponse>;
2396
+ /**
2397
+ * Get onboarding status for an organization.
2398
+ */
2399
+ getOnboardingStatus(orgId: string, userId: string): Promise<EmailOnboardStatusResponse>;
2400
+ /**
2401
+ * Get current settings for an organization.
2402
+ */
2403
+ getSettings(orgId: string, userId: string): Promise<EmailOrgSettingsResponse>;
2404
+ /**
2405
+ * Update organization settings. Requires admin role.
2406
+ */
2407
+ updateSettings(orgId: string, userId: string, update: EmailOrgSettingsUpdate): Promise<EmailOrgSettingsResponse>;
2408
+ /**
2409
+ * Get health summary for an organization.
2410
+ */
2411
+ getHealth(orgId: string, userId: string): Promise<EmailOrgHealthResponse>;
2412
+ /**
2413
+ * Add a new sender persona to an organization.
2414
+ * Provisions mailboxes on existing domains. Requires admin role.
2415
+ */
2416
+ addPersona(orgId: string, userId: string, persona: AddPersonaRequest): Promise<AddPersonaResponse>;
2417
+ /**
2418
+ * Teardown an email organization's infrastructure.
2419
+ *
2420
+ * Full decommission: cancels warmup, InfraGuard, and mailboxes.
2421
+ * Requires admin role on the org.
2422
+ */
2423
+ teardown(orgId: string, userId: string): Promise<TeardownOrgResponse>;
2424
+ /**
2425
+ * Add a user to an organization. Requires admin role.
2426
+ */
2427
+ addMember(orgId: string, userId: string, member: AddOrgMemberRequest): Promise<AddOrgMemberResponse>;
2428
+ /**
2429
+ * Remove a user from an organization. Requires admin role.
2430
+ */
2431
+ removeMember(orgId: string, userId: string, memberEmail: string): Promise<RemoveOrgMemberResponse>;
2432
+ }
2433
+
2266
2434
  /** Input for one person to enrich */
2267
2435
  interface ContactEnrichPersonInput {
2268
2436
  linkedinUrl?: string | null;
@@ -5562,6 +5730,7 @@ declare class LumnisClient {
5562
5730
  readonly campaigns: CampaignsResource;
5563
5731
  readonly contactRelationships: ContactRelationshipsResource;
5564
5732
  readonly enrichment: EnrichmentResource;
5733
+ readonly email: EmailResource;
5565
5734
  private readonly _scopedUserId?;
5566
5735
  private readonly _defaultScope;
5567
5736
  constructor(options?: LumnisClientOptions);
@@ -5914,4 +6083,4 @@ declare class ProgressTracker {
5914
6083
  */
5915
6084
  declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
5916
6085
 
5917
- 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 };
6086
+ 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;
@@ -4156,6 +4264,7 @@ class LumnisClient {
4156
4264
  campaigns;
4157
4265
  contactRelationships;
4158
4266
  enrichment;
4267
+ email;
4159
4268
  _scopedUserId;
4160
4269
  _defaultScope;
4161
4270
  constructor(options = {}) {
@@ -4192,6 +4301,7 @@ class LumnisClient {
4192
4301
  this.campaigns = new CampaignsResource(this.http);
4193
4302
  this.contactRelationships = new ContactRelationshipsResource(this.http);
4194
4303
  this.enrichment = new EnrichmentResource(this.http);
4304
+ this.email = new EmailResource(this.http);
4195
4305
  }
4196
4306
  forUser(userId) {
4197
4307
  return new LumnisClient({
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "lumnisai",
3
3
  "type": "module",
4
- "version": "0.5.13",
4
+ "version": "0.5.15",
5
5
  "description": "Official Node.js SDK for the Lumnis AI API",
6
6
  "author": "Lumnis AI",
7
7
  "license": "MIT",