lumnisai 0.5.23 → 0.5.24

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
@@ -1083,6 +1083,31 @@ class EmailResource {
1083
1083
  { params: { user_id: userId } }
1084
1084
  );
1085
1085
  }
1086
+ // ==================== BYO Inboxes ====================
1087
+ /**
1088
+ * Connect a customer's own email inbox (Gmail/Outlook/IMAP) via Unipile.
1089
+ *
1090
+ * One call = one inbox. Returns a hosted-auth redirect URL; the user authes
1091
+ * there and the connect webhook creates the `ready` mailbox. Call once per
1092
+ * inbox to add multiple mailboxes.
1093
+ */
1094
+ async connectInbox(request) {
1095
+ return this.http.post("/email/inboxes/connect", request);
1096
+ }
1097
+ /**
1098
+ * Update a single mailbox's send settings (per-mailbox daily cap, pause).
1099
+ *
1100
+ * PATCH semantics — only provided fields change. The per-mailbox cap is the
1101
+ * primary lever for BYO inboxes, which skip the InboxKit warmup ramp.
1102
+ * Requires admin role on the org.
1103
+ */
1104
+ async updateMailbox(orgId, mailboxId, userId, update) {
1105
+ return this.http.patch(
1106
+ `/email/organizations/${encodeURIComponent(orgId)}/mailboxes/${encodeURIComponent(mailboxId)}`,
1107
+ update,
1108
+ { params: { user_id: userId } }
1109
+ );
1110
+ }
1086
1111
  // ==================== Teardown ====================
1087
1112
  /**
1088
1113
  * Teardown an email organization's infrastructure.
@@ -2845,6 +2870,71 @@ class ModelPreferencesResource {
2845
2870
  }
2846
2871
  }
2847
2872
 
2873
+ class OutreachResource {
2874
+ constructor(http) {
2875
+ this.http = http;
2876
+ }
2877
+ /**
2878
+ * List people at a funnel stage (connected/messaged/replied/meeting_booked),
2879
+ * or `stage='all'` for one row per person at their furthest stage.
2880
+ *
2881
+ * Pass `stats: true` to also get the per-channel funnel counts + conversion
2882
+ * ratios for the same scope (`userId`/`source`/`campaignId`) alongside the
2883
+ * people list. Pass `campaignId` to restrict to specific campaigns (this
2884
+ * excludes sequences).
2885
+ *
2886
+ * @example
2887
+ * ```typescript
2888
+ * const result = await client.outreach.listConnections({
2889
+ * userId: 'user@example.com',
2890
+ * stage: 'replied',
2891
+ * stats: true,
2892
+ * })
2893
+ * console.log(result.total, result.stats?.byChannel.linkedin.ratios.replyRate)
2894
+ * ```
2895
+ */
2896
+ async listConnections(params) {
2897
+ const query = new URLSearchParams();
2898
+ query.append("user_id", params.userId);
2899
+ if (params.stage !== void 0)
2900
+ query.append("stage", params.stage);
2901
+ if (params.channel !== void 0)
2902
+ query.append("channel", params.channel);
2903
+ if (params.source !== void 0)
2904
+ query.append("source", params.source);
2905
+ if (params.campaignId)
2906
+ params.campaignId.forEach((id) => query.append("campaign_id", id));
2907
+ if (params.since !== void 0)
2908
+ query.append("since", params.since);
2909
+ if (params.stats !== void 0)
2910
+ query.append("stats", String(params.stats));
2911
+ if (params.limit !== void 0)
2912
+ query.append("limit", String(params.limit));
2913
+ if (params.offset !== void 0)
2914
+ query.append("offset", String(params.offset));
2915
+ return this.http.get(`/outreach?${query.toString()}`);
2916
+ }
2917
+ /**
2918
+ * Alias for `stage='connected'` — people who accepted a Lumnis-sent
2919
+ * connection request.
2920
+ */
2921
+ async listAcceptedConnections(params) {
2922
+ const query = new URLSearchParams();
2923
+ query.append("user_id", params.userId);
2924
+ if (params.source !== void 0)
2925
+ query.append("source", params.source);
2926
+ if (params.campaignId)
2927
+ params.campaignId.forEach((id) => query.append("campaign_id", id));
2928
+ if (params.since !== void 0)
2929
+ query.append("since", params.since);
2930
+ if (params.limit !== void 0)
2931
+ query.append("limit", String(params.limit));
2932
+ if (params.offset !== void 0)
2933
+ query.append("offset", String(params.offset));
2934
+ return this.http.get(`/outreach/accepted?${query.toString()}`);
2935
+ }
2936
+ }
2937
+
2848
2938
  var PeopleDataSource = /* @__PURE__ */ ((PeopleDataSource2) => {
2849
2939
  PeopleDataSource2["PDL"] = "PDL";
2850
2940
  PeopleDataSource2["CORESIGNAL"] = "CORESIGNAL";
@@ -4620,6 +4710,7 @@ class LumnisClient {
4620
4710
  enrichment;
4621
4711
  email;
4622
4712
  crm;
4713
+ outreach;
4623
4714
  _scopedUserId;
4624
4715
  _defaultScope;
4625
4716
  constructor(options = {}) {
@@ -4658,6 +4749,7 @@ class LumnisClient {
4658
4749
  this.enrichment = new EnrichmentResource(this.http);
4659
4750
  this.email = new EmailResource(this.http);
4660
4751
  this.crm = new CrmResource(this.http);
4752
+ this.outreach = new OutreachResource(this.http);
4661
4753
  }
4662
4754
  forUser(userId) {
4663
4755
  return new LumnisClient({
package/dist/index.d.cts CHANGED
@@ -376,6 +376,12 @@ interface DisconnectRequest {
376
376
  userId: string;
377
377
  appName: string;
378
378
  provider?: ProviderType;
379
+ /**
380
+ * Specific account to disconnect. Required to disconnect a single inbox when a
381
+ * user has multiple accounts for the same app (e.g. several BYO email
382
+ * mailboxes connected via Unipile). Omit for single-account apps.
383
+ */
384
+ accountId?: string;
379
385
  }
380
386
  interface DisconnectResponse {
381
387
  success: boolean;
@@ -3264,6 +3270,33 @@ interface AddOrgMemberRequest {
3264
3270
  email: string;
3265
3271
  role?: string;
3266
3272
  }
3273
+ /**
3274
+ * Connect a customer's own (BYO) email inbox (Gmail/Outlook/IMAP) via Unipile
3275
+ * hosted auth. One call = one inbox; call once per inbox to add multiple.
3276
+ */
3277
+ interface ConnectInboxRequest {
3278
+ userId: string;
3279
+ /** Email provider code: GOOGLE | OUTLOOK | MAIL. Defaults to GOOGLE. */
3280
+ appName?: string;
3281
+ /** Base URL for OAuth success/failure callbacks. */
3282
+ redirectUrl: string;
3283
+ /** Org to attach the mailbox to (defaults to the tenant BYO org). */
3284
+ organizationId?: string;
3285
+ /** Persona to attach to (defaults to the shared BYO persona). */
3286
+ personaId?: string;
3287
+ /** Initial per-mailbox daily cap; no hard ceiling, defaults to 40. */
3288
+ dailySendCap?: number;
3289
+ }
3290
+ /**
3291
+ * Update a single mailbox's send settings. PATCH semantics — only provided
3292
+ * fields change.
3293
+ */
3294
+ interface MailboxUpdateRequest {
3295
+ /** Per-mailbox daily send cap (>= 1). No hard upper bound. */
3296
+ dailySendCap?: number;
3297
+ /** Pause/unpause the mailbox. */
3298
+ paused?: boolean;
3299
+ }
3267
3300
  interface EmailOnboardResponse {
3268
3301
  organizationId: string;
3269
3302
  status: string;
@@ -3336,6 +3369,20 @@ interface RemoveOrgMemberResponse {
3336
3369
  interface TeardownOrgResponse {
3337
3370
  message: string;
3338
3371
  }
3372
+ interface ConnectInboxResponse {
3373
+ /** Hosted-auth redirect URL; the user authes there to complete the connect. */
3374
+ redirectUrl?: string | null;
3375
+ status?: string | null;
3376
+ }
3377
+ interface MailboxUpdateResponse {
3378
+ mailboxId: string;
3379
+ emailAddress: string;
3380
+ status: string;
3381
+ dailySendCap: number;
3382
+ sendsToday: number;
3383
+ /** Where this mailbox came from: inboxkit | unipile | smtp. */
3384
+ source: string;
3385
+ }
3339
3386
 
3340
3387
  /**
3341
3388
  * Resource for managing email infrastructure.
@@ -3387,6 +3434,22 @@ declare class EmailResource {
3387
3434
  * cap. Requires admin role.
3388
3435
  */
3389
3436
  updatePersona(orgId: string, userId: string, personaId: string, update: UpdatePersonaRequest): Promise<UpdatePersonaResponse>;
3437
+ /**
3438
+ * Connect a customer's own email inbox (Gmail/Outlook/IMAP) via Unipile.
3439
+ *
3440
+ * One call = one inbox. Returns a hosted-auth redirect URL; the user authes
3441
+ * there and the connect webhook creates the `ready` mailbox. Call once per
3442
+ * inbox to add multiple mailboxes.
3443
+ */
3444
+ connectInbox(request: ConnectInboxRequest): Promise<ConnectInboxResponse>;
3445
+ /**
3446
+ * Update a single mailbox's send settings (per-mailbox daily cap, pause).
3447
+ *
3448
+ * PATCH semantics — only provided fields change. The per-mailbox cap is the
3449
+ * primary lever for BYO inboxes, which skip the InboxKit warmup ramp.
3450
+ * Requires admin role on the org.
3451
+ */
3452
+ updateMailbox(orgId: string, mailboxId: string, userId: string, update: MailboxUpdateRequest): Promise<MailboxUpdateResponse>;
3390
3453
  /**
3391
3454
  * Teardown an email organization's infrastructure.
3392
3455
  *
@@ -5333,6 +5396,166 @@ declare class ModelPreferencesResource {
5333
5396
  }): Promise<TenantModelPreferencesResponse>;
5334
5397
  }
5335
5398
 
5399
+ /**
5400
+ * Outreach connections (funnel-people + stats) types.
5401
+ *
5402
+ * These map to the Python backend endpoints under /v1/outreach, which list the
5403
+ * PEOPLE behind any outreach funnel stage — connected, messaged, replied, or
5404
+ * meeting_booked — reached via Lumnis through a sequence or an AI campaign.
5405
+ */
5406
+ /** Concrete funnel stage on a per-person row. */
5407
+ type Stage = 'connected' | 'messaged' | 'replied' | 'meeting_booked';
5408
+ /** Stage filter accepted on the request (and echoed on the response). */
5409
+ type StageFilter = 'all' | 'connected' | 'messaged' | 'replied' | 'meeting_booked';
5410
+ /** Channel filter — applies to the "messaged" stage (LinkedIn DM vs InMail vs email). */
5411
+ type Channel = 'all' | 'linkedin' | 'email' | 'inmail';
5412
+ /** Which outreach system a row came from. */
5413
+ type OutreachSource = 'all' | 'sequence' | 'campaign';
5414
+ interface ListConnectionsParams {
5415
+ /** User ID or email (REQUIRED) — results are scoped to this user. */
5416
+ userId: string;
5417
+ /** Funnel stage, or 'all' for the furthest stage per person. Defaults to 'connected'. */
5418
+ stage?: StageFilter;
5419
+ /** For stage='messaged': linkedin | email | inmail | all. Defaults to 'all'. */
5420
+ channel?: Channel;
5421
+ /** Restrict to a single outreach system. Defaults to 'all'. */
5422
+ source?: OutreachSource;
5423
+ /**
5424
+ * One or more campaign IDs to filter to. When set, results are campaign-only
5425
+ * (sequences are excluded).
5426
+ */
5427
+ campaignId?: string[];
5428
+ /** Only include rows reaching the stage on/after this date (YYYY-MM-DD). */
5429
+ since?: string;
5430
+ /** Also return the per-channel funnel stats + ratios for the scope. Defaults to false. */
5431
+ stats?: boolean;
5432
+ limit?: number;
5433
+ offset?: number;
5434
+ }
5435
+ interface ListAcceptedConnectionsParams {
5436
+ /** User ID or email (REQUIRED) — results are scoped to this user. */
5437
+ userId: string;
5438
+ /** Restrict to a single outreach system. Defaults to 'all'. */
5439
+ source?: OutreachSource;
5440
+ /** One or more campaign IDs to filter to (campaign-only when set). */
5441
+ campaignId?: string[];
5442
+ /** Only include rows accepted on/after this date (YYYY-MM-DD). */
5443
+ since?: string;
5444
+ limit?: number;
5445
+ offset?: number;
5446
+ }
5447
+ /**
5448
+ * A person at a given outreach funnel stage, reached via Lumnis.
5449
+ *
5450
+ * When `stage='all'` was requested, `stage` is the FURTHEST stage this person
5451
+ * reached (meeting_booked > replied > messaged > connected) and `stageAt` is
5452
+ * that stage's timestamp.
5453
+ */
5454
+ interface Connection {
5455
+ rowId: string;
5456
+ source: 'sequence' | 'campaign';
5457
+ sourceId: string;
5458
+ sourceName?: string | null;
5459
+ userId?: string | null;
5460
+ fullName?: string | null;
5461
+ title?: string | null;
5462
+ company?: string | null;
5463
+ linkedinUrl?: string | null;
5464
+ providerId?: string | null;
5465
+ senderAccountId?: string | null;
5466
+ stage: Stage;
5467
+ stageAt?: string | null;
5468
+ }
5469
+ /**
5470
+ * Conversion ratios WITHIN one channel — all <= 1.0 (100%) by construction.
5471
+ *
5472
+ * `connectRate` / `messageRate` apply only to LinkedIn (InMail/email have no
5473
+ * connect step, so they are `null` there). `null` whenever the denominator is 0.
5474
+ */
5475
+ interface ChannelRatios {
5476
+ /** connected / connectionRequestsSent (LinkedIn only) */
5477
+ connectRate?: number | null;
5478
+ /** sent / connected (LinkedIn only) */
5479
+ messageRate?: number | null;
5480
+ /** replied / sent */
5481
+ replyRate?: number | null;
5482
+ /** meetingBooked / replied (a.k.a. book rate) */
5483
+ meetingRate?: number | null;
5484
+ }
5485
+ /**
5486
+ * One channel's funnel. For InMail/email, `connectionRequestsSent` and
5487
+ * `connected` are 0 (those channels have no connect step).
5488
+ */
5489
+ interface ChannelFunnel {
5490
+ /** LinkedIn only (0 for inmail/email). */
5491
+ connectionRequestsSent: number;
5492
+ /** LinkedIn only (0 for inmail/email). */
5493
+ connected: number;
5494
+ /** Messages sent in this channel (DMs / InMails / emails). */
5495
+ sent: number;
5496
+ replied: number;
5497
+ meetingBooked: number;
5498
+ ratios: ChannelRatios;
5499
+ }
5500
+ /**
5501
+ * Per-channel funnels, folded into the list response when `stats=true`.
5502
+ *
5503
+ * Channels are reported separately on purpose so conversion ratios stay valid.
5504
+ * Keys: 'linkedin', 'inmail', 'email'.
5505
+ */
5506
+ interface OutreachStats {
5507
+ byChannel: Record<string, ChannelFunnel>;
5508
+ }
5509
+ interface ConnectionsResponse {
5510
+ items: Connection[];
5511
+ total: number;
5512
+ stage: StageFilter;
5513
+ channel: Channel;
5514
+ limit: number;
5515
+ offset: number;
5516
+ stats?: OutreachStats | null;
5517
+ computedAt: string;
5518
+ }
5519
+
5520
+ /**
5521
+ * Resource for the outreach connections (funnel-people) API.
5522
+ *
5523
+ * Cross-system read endpoints that list the PEOPLE behind any outreach funnel
5524
+ * stage — connected (accepted a CR), messaged, replied, or meeting_booked —
5525
+ * reached via Lumnis, whether through a traditional sequence or an AI campaign.
5526
+ *
5527
+ * Wraps `GET /v1/outreach` and `GET /v1/outreach/accepted`.
5528
+ */
5529
+ declare class OutreachResource {
5530
+ private readonly http;
5531
+ constructor(http: Http);
5532
+ /**
5533
+ * List people at a funnel stage (connected/messaged/replied/meeting_booked),
5534
+ * or `stage='all'` for one row per person at their furthest stage.
5535
+ *
5536
+ * Pass `stats: true` to also get the per-channel funnel counts + conversion
5537
+ * ratios for the same scope (`userId`/`source`/`campaignId`) alongside the
5538
+ * people list. Pass `campaignId` to restrict to specific campaigns (this
5539
+ * excludes sequences).
5540
+ *
5541
+ * @example
5542
+ * ```typescript
5543
+ * const result = await client.outreach.listConnections({
5544
+ * userId: 'user@example.com',
5545
+ * stage: 'replied',
5546
+ * stats: true,
5547
+ * })
5548
+ * console.log(result.total, result.stats?.byChannel.linkedin.ratios.replyRate)
5549
+ * ```
5550
+ */
5551
+ listConnections(params: ListConnectionsParams): Promise<ConnectionsResponse>;
5552
+ /**
5553
+ * Alias for `stage='connected'` — people who accepted a Lumnis-sent
5554
+ * connection request.
5555
+ */
5556
+ listAcceptedConnections(params: ListAcceptedConnectionsParams): Promise<ConnectionsResponse>;
5557
+ }
5558
+
5336
5559
  declare class PeopleResource {
5337
5560
  private readonly http;
5338
5561
  constructor(http: Http);
@@ -6858,6 +7081,7 @@ declare class LumnisClient {
6858
7081
  readonly enrichment: EnrichmentResource;
6859
7082
  readonly email: EmailResource;
6860
7083
  readonly crm: CrmResource;
7084
+ readonly outreach: OutreachResource;
6861
7085
  private readonly _scopedUserId?;
6862
7086
  private readonly _defaultScope;
6863
7087
  constructor(options?: LumnisClientOptions);
@@ -7210,4 +7434,4 @@ declare class ProgressTracker {
7210
7434
  */
7211
7435
  declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
7212
7436
 
7213
- export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, 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, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, 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, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type 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 PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, 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, type SkippedTransferProspect, 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 TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
7437
+ export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type Channel, type ChannelContactHistory, type ChannelFunnel, type ChannelRatios, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectInboxRequest, type ConnectInboxResponse, type Connection, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsResponse, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type 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, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, 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, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type ListAcceptedConnectionsParams, type ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListConnectionsParams, type ListExecutionsOptions, type ListPendingApprovalsOptions, type ListPlaybooksOptions, type ListProvidersResponse, type ListStepExecutionsOptions, type ListTemplatesOptions, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type MailboxUpdateRequest, type MailboxUpdateResponse, type Message, type MessageReceivedData, type MessageResponse, type MessageSentData, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingResource, MessagingSendError, MessagingValidationError, type MetricsParams, type MetricsRequestItem, type MetricsResponseItem, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NetworkDistance, NoDataSourcesError, NotFoundError, type OnFailure, type OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, OutreachResource, type OutreachSource, type OutreachStats, 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 PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, 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, type SkippedTransferProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type Stage, type StageFilter, 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 TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
package/dist/index.d.mts CHANGED
@@ -376,6 +376,12 @@ interface DisconnectRequest {
376
376
  userId: string;
377
377
  appName: string;
378
378
  provider?: ProviderType;
379
+ /**
380
+ * Specific account to disconnect. Required to disconnect a single inbox when a
381
+ * user has multiple accounts for the same app (e.g. several BYO email
382
+ * mailboxes connected via Unipile). Omit for single-account apps.
383
+ */
384
+ accountId?: string;
379
385
  }
380
386
  interface DisconnectResponse {
381
387
  success: boolean;
@@ -3264,6 +3270,33 @@ interface AddOrgMemberRequest {
3264
3270
  email: string;
3265
3271
  role?: string;
3266
3272
  }
3273
+ /**
3274
+ * Connect a customer's own (BYO) email inbox (Gmail/Outlook/IMAP) via Unipile
3275
+ * hosted auth. One call = one inbox; call once per inbox to add multiple.
3276
+ */
3277
+ interface ConnectInboxRequest {
3278
+ userId: string;
3279
+ /** Email provider code: GOOGLE | OUTLOOK | MAIL. Defaults to GOOGLE. */
3280
+ appName?: string;
3281
+ /** Base URL for OAuth success/failure callbacks. */
3282
+ redirectUrl: string;
3283
+ /** Org to attach the mailbox to (defaults to the tenant BYO org). */
3284
+ organizationId?: string;
3285
+ /** Persona to attach to (defaults to the shared BYO persona). */
3286
+ personaId?: string;
3287
+ /** Initial per-mailbox daily cap; no hard ceiling, defaults to 40. */
3288
+ dailySendCap?: number;
3289
+ }
3290
+ /**
3291
+ * Update a single mailbox's send settings. PATCH semantics — only provided
3292
+ * fields change.
3293
+ */
3294
+ interface MailboxUpdateRequest {
3295
+ /** Per-mailbox daily send cap (>= 1). No hard upper bound. */
3296
+ dailySendCap?: number;
3297
+ /** Pause/unpause the mailbox. */
3298
+ paused?: boolean;
3299
+ }
3267
3300
  interface EmailOnboardResponse {
3268
3301
  organizationId: string;
3269
3302
  status: string;
@@ -3336,6 +3369,20 @@ interface RemoveOrgMemberResponse {
3336
3369
  interface TeardownOrgResponse {
3337
3370
  message: string;
3338
3371
  }
3372
+ interface ConnectInboxResponse {
3373
+ /** Hosted-auth redirect URL; the user authes there to complete the connect. */
3374
+ redirectUrl?: string | null;
3375
+ status?: string | null;
3376
+ }
3377
+ interface MailboxUpdateResponse {
3378
+ mailboxId: string;
3379
+ emailAddress: string;
3380
+ status: string;
3381
+ dailySendCap: number;
3382
+ sendsToday: number;
3383
+ /** Where this mailbox came from: inboxkit | unipile | smtp. */
3384
+ source: string;
3385
+ }
3339
3386
 
3340
3387
  /**
3341
3388
  * Resource for managing email infrastructure.
@@ -3387,6 +3434,22 @@ declare class EmailResource {
3387
3434
  * cap. Requires admin role.
3388
3435
  */
3389
3436
  updatePersona(orgId: string, userId: string, personaId: string, update: UpdatePersonaRequest): Promise<UpdatePersonaResponse>;
3437
+ /**
3438
+ * Connect a customer's own email inbox (Gmail/Outlook/IMAP) via Unipile.
3439
+ *
3440
+ * One call = one inbox. Returns a hosted-auth redirect URL; the user authes
3441
+ * there and the connect webhook creates the `ready` mailbox. Call once per
3442
+ * inbox to add multiple mailboxes.
3443
+ */
3444
+ connectInbox(request: ConnectInboxRequest): Promise<ConnectInboxResponse>;
3445
+ /**
3446
+ * Update a single mailbox's send settings (per-mailbox daily cap, pause).
3447
+ *
3448
+ * PATCH semantics — only provided fields change. The per-mailbox cap is the
3449
+ * primary lever for BYO inboxes, which skip the InboxKit warmup ramp.
3450
+ * Requires admin role on the org.
3451
+ */
3452
+ updateMailbox(orgId: string, mailboxId: string, userId: string, update: MailboxUpdateRequest): Promise<MailboxUpdateResponse>;
3390
3453
  /**
3391
3454
  * Teardown an email organization's infrastructure.
3392
3455
  *
@@ -5333,6 +5396,166 @@ declare class ModelPreferencesResource {
5333
5396
  }): Promise<TenantModelPreferencesResponse>;
5334
5397
  }
5335
5398
 
5399
+ /**
5400
+ * Outreach connections (funnel-people + stats) types.
5401
+ *
5402
+ * These map to the Python backend endpoints under /v1/outreach, which list the
5403
+ * PEOPLE behind any outreach funnel stage — connected, messaged, replied, or
5404
+ * meeting_booked — reached via Lumnis through a sequence or an AI campaign.
5405
+ */
5406
+ /** Concrete funnel stage on a per-person row. */
5407
+ type Stage = 'connected' | 'messaged' | 'replied' | 'meeting_booked';
5408
+ /** Stage filter accepted on the request (and echoed on the response). */
5409
+ type StageFilter = 'all' | 'connected' | 'messaged' | 'replied' | 'meeting_booked';
5410
+ /** Channel filter — applies to the "messaged" stage (LinkedIn DM vs InMail vs email). */
5411
+ type Channel = 'all' | 'linkedin' | 'email' | 'inmail';
5412
+ /** Which outreach system a row came from. */
5413
+ type OutreachSource = 'all' | 'sequence' | 'campaign';
5414
+ interface ListConnectionsParams {
5415
+ /** User ID or email (REQUIRED) — results are scoped to this user. */
5416
+ userId: string;
5417
+ /** Funnel stage, or 'all' for the furthest stage per person. Defaults to 'connected'. */
5418
+ stage?: StageFilter;
5419
+ /** For stage='messaged': linkedin | email | inmail | all. Defaults to 'all'. */
5420
+ channel?: Channel;
5421
+ /** Restrict to a single outreach system. Defaults to 'all'. */
5422
+ source?: OutreachSource;
5423
+ /**
5424
+ * One or more campaign IDs to filter to. When set, results are campaign-only
5425
+ * (sequences are excluded).
5426
+ */
5427
+ campaignId?: string[];
5428
+ /** Only include rows reaching the stage on/after this date (YYYY-MM-DD). */
5429
+ since?: string;
5430
+ /** Also return the per-channel funnel stats + ratios for the scope. Defaults to false. */
5431
+ stats?: boolean;
5432
+ limit?: number;
5433
+ offset?: number;
5434
+ }
5435
+ interface ListAcceptedConnectionsParams {
5436
+ /** User ID or email (REQUIRED) — results are scoped to this user. */
5437
+ userId: string;
5438
+ /** Restrict to a single outreach system. Defaults to 'all'. */
5439
+ source?: OutreachSource;
5440
+ /** One or more campaign IDs to filter to (campaign-only when set). */
5441
+ campaignId?: string[];
5442
+ /** Only include rows accepted on/after this date (YYYY-MM-DD). */
5443
+ since?: string;
5444
+ limit?: number;
5445
+ offset?: number;
5446
+ }
5447
+ /**
5448
+ * A person at a given outreach funnel stage, reached via Lumnis.
5449
+ *
5450
+ * When `stage='all'` was requested, `stage` is the FURTHEST stage this person
5451
+ * reached (meeting_booked > replied > messaged > connected) and `stageAt` is
5452
+ * that stage's timestamp.
5453
+ */
5454
+ interface Connection {
5455
+ rowId: string;
5456
+ source: 'sequence' | 'campaign';
5457
+ sourceId: string;
5458
+ sourceName?: string | null;
5459
+ userId?: string | null;
5460
+ fullName?: string | null;
5461
+ title?: string | null;
5462
+ company?: string | null;
5463
+ linkedinUrl?: string | null;
5464
+ providerId?: string | null;
5465
+ senderAccountId?: string | null;
5466
+ stage: Stage;
5467
+ stageAt?: string | null;
5468
+ }
5469
+ /**
5470
+ * Conversion ratios WITHIN one channel — all <= 1.0 (100%) by construction.
5471
+ *
5472
+ * `connectRate` / `messageRate` apply only to LinkedIn (InMail/email have no
5473
+ * connect step, so they are `null` there). `null` whenever the denominator is 0.
5474
+ */
5475
+ interface ChannelRatios {
5476
+ /** connected / connectionRequestsSent (LinkedIn only) */
5477
+ connectRate?: number | null;
5478
+ /** sent / connected (LinkedIn only) */
5479
+ messageRate?: number | null;
5480
+ /** replied / sent */
5481
+ replyRate?: number | null;
5482
+ /** meetingBooked / replied (a.k.a. book rate) */
5483
+ meetingRate?: number | null;
5484
+ }
5485
+ /**
5486
+ * One channel's funnel. For InMail/email, `connectionRequestsSent` and
5487
+ * `connected` are 0 (those channels have no connect step).
5488
+ */
5489
+ interface ChannelFunnel {
5490
+ /** LinkedIn only (0 for inmail/email). */
5491
+ connectionRequestsSent: number;
5492
+ /** LinkedIn only (0 for inmail/email). */
5493
+ connected: number;
5494
+ /** Messages sent in this channel (DMs / InMails / emails). */
5495
+ sent: number;
5496
+ replied: number;
5497
+ meetingBooked: number;
5498
+ ratios: ChannelRatios;
5499
+ }
5500
+ /**
5501
+ * Per-channel funnels, folded into the list response when `stats=true`.
5502
+ *
5503
+ * Channels are reported separately on purpose so conversion ratios stay valid.
5504
+ * Keys: 'linkedin', 'inmail', 'email'.
5505
+ */
5506
+ interface OutreachStats {
5507
+ byChannel: Record<string, ChannelFunnel>;
5508
+ }
5509
+ interface ConnectionsResponse {
5510
+ items: Connection[];
5511
+ total: number;
5512
+ stage: StageFilter;
5513
+ channel: Channel;
5514
+ limit: number;
5515
+ offset: number;
5516
+ stats?: OutreachStats | null;
5517
+ computedAt: string;
5518
+ }
5519
+
5520
+ /**
5521
+ * Resource for the outreach connections (funnel-people) API.
5522
+ *
5523
+ * Cross-system read endpoints that list the PEOPLE behind any outreach funnel
5524
+ * stage — connected (accepted a CR), messaged, replied, or meeting_booked —
5525
+ * reached via Lumnis, whether through a traditional sequence or an AI campaign.
5526
+ *
5527
+ * Wraps `GET /v1/outreach` and `GET /v1/outreach/accepted`.
5528
+ */
5529
+ declare class OutreachResource {
5530
+ private readonly http;
5531
+ constructor(http: Http);
5532
+ /**
5533
+ * List people at a funnel stage (connected/messaged/replied/meeting_booked),
5534
+ * or `stage='all'` for one row per person at their furthest stage.
5535
+ *
5536
+ * Pass `stats: true` to also get the per-channel funnel counts + conversion
5537
+ * ratios for the same scope (`userId`/`source`/`campaignId`) alongside the
5538
+ * people list. Pass `campaignId` to restrict to specific campaigns (this
5539
+ * excludes sequences).
5540
+ *
5541
+ * @example
5542
+ * ```typescript
5543
+ * const result = await client.outreach.listConnections({
5544
+ * userId: 'user@example.com',
5545
+ * stage: 'replied',
5546
+ * stats: true,
5547
+ * })
5548
+ * console.log(result.total, result.stats?.byChannel.linkedin.ratios.replyRate)
5549
+ * ```
5550
+ */
5551
+ listConnections(params: ListConnectionsParams): Promise<ConnectionsResponse>;
5552
+ /**
5553
+ * Alias for `stage='connected'` — people who accepted a Lumnis-sent
5554
+ * connection request.
5555
+ */
5556
+ listAcceptedConnections(params: ListAcceptedConnectionsParams): Promise<ConnectionsResponse>;
5557
+ }
5558
+
5336
5559
  declare class PeopleResource {
5337
5560
  private readonly http;
5338
5561
  constructor(http: Http);
@@ -6858,6 +7081,7 @@ declare class LumnisClient {
6858
7081
  readonly enrichment: EnrichmentResource;
6859
7082
  readonly email: EmailResource;
6860
7083
  readonly crm: CrmResource;
7084
+ readonly outreach: OutreachResource;
6861
7085
  private readonly _scopedUserId?;
6862
7086
  private readonly _defaultScope;
6863
7087
  constructor(options?: LumnisClientOptions);
@@ -7210,4 +7434,4 @@ declare class ProgressTracker {
7210
7434
  */
7211
7435
  declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
7212
7436
 
7213
- export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, 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, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, 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, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type 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 PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, 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, type SkippedTransferProspect, 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 TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
7437
+ export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type Channel, type ChannelContactHistory, type ChannelFunnel, type ChannelRatios, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectInboxRequest, type ConnectInboxResponse, type Connection, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsResponse, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type 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, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, 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, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type ListAcceptedConnectionsParams, type ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListConnectionsParams, type ListExecutionsOptions, type ListPendingApprovalsOptions, type ListPlaybooksOptions, type ListProvidersResponse, type ListStepExecutionsOptions, type ListTemplatesOptions, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type MailboxUpdateRequest, type MailboxUpdateResponse, type Message, type MessageReceivedData, type MessageResponse, type MessageSentData, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingResource, MessagingSendError, MessagingValidationError, type MetricsParams, type MetricsRequestItem, type MetricsResponseItem, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NetworkDistance, NoDataSourcesError, NotFoundError, type OnFailure, type OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, OutreachResource, type OutreachSource, type OutreachStats, 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 PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, 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, type SkippedTransferProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type Stage, type StageFilter, 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 TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
package/dist/index.d.ts CHANGED
@@ -376,6 +376,12 @@ interface DisconnectRequest {
376
376
  userId: string;
377
377
  appName: string;
378
378
  provider?: ProviderType;
379
+ /**
380
+ * Specific account to disconnect. Required to disconnect a single inbox when a
381
+ * user has multiple accounts for the same app (e.g. several BYO email
382
+ * mailboxes connected via Unipile). Omit for single-account apps.
383
+ */
384
+ accountId?: string;
379
385
  }
380
386
  interface DisconnectResponse {
381
387
  success: boolean;
@@ -3264,6 +3270,33 @@ interface AddOrgMemberRequest {
3264
3270
  email: string;
3265
3271
  role?: string;
3266
3272
  }
3273
+ /**
3274
+ * Connect a customer's own (BYO) email inbox (Gmail/Outlook/IMAP) via Unipile
3275
+ * hosted auth. One call = one inbox; call once per inbox to add multiple.
3276
+ */
3277
+ interface ConnectInboxRequest {
3278
+ userId: string;
3279
+ /** Email provider code: GOOGLE | OUTLOOK | MAIL. Defaults to GOOGLE. */
3280
+ appName?: string;
3281
+ /** Base URL for OAuth success/failure callbacks. */
3282
+ redirectUrl: string;
3283
+ /** Org to attach the mailbox to (defaults to the tenant BYO org). */
3284
+ organizationId?: string;
3285
+ /** Persona to attach to (defaults to the shared BYO persona). */
3286
+ personaId?: string;
3287
+ /** Initial per-mailbox daily cap; no hard ceiling, defaults to 40. */
3288
+ dailySendCap?: number;
3289
+ }
3290
+ /**
3291
+ * Update a single mailbox's send settings. PATCH semantics — only provided
3292
+ * fields change.
3293
+ */
3294
+ interface MailboxUpdateRequest {
3295
+ /** Per-mailbox daily send cap (>= 1). No hard upper bound. */
3296
+ dailySendCap?: number;
3297
+ /** Pause/unpause the mailbox. */
3298
+ paused?: boolean;
3299
+ }
3267
3300
  interface EmailOnboardResponse {
3268
3301
  organizationId: string;
3269
3302
  status: string;
@@ -3336,6 +3369,20 @@ interface RemoveOrgMemberResponse {
3336
3369
  interface TeardownOrgResponse {
3337
3370
  message: string;
3338
3371
  }
3372
+ interface ConnectInboxResponse {
3373
+ /** Hosted-auth redirect URL; the user authes there to complete the connect. */
3374
+ redirectUrl?: string | null;
3375
+ status?: string | null;
3376
+ }
3377
+ interface MailboxUpdateResponse {
3378
+ mailboxId: string;
3379
+ emailAddress: string;
3380
+ status: string;
3381
+ dailySendCap: number;
3382
+ sendsToday: number;
3383
+ /** Where this mailbox came from: inboxkit | unipile | smtp. */
3384
+ source: string;
3385
+ }
3339
3386
 
3340
3387
  /**
3341
3388
  * Resource for managing email infrastructure.
@@ -3387,6 +3434,22 @@ declare class EmailResource {
3387
3434
  * cap. Requires admin role.
3388
3435
  */
3389
3436
  updatePersona(orgId: string, userId: string, personaId: string, update: UpdatePersonaRequest): Promise<UpdatePersonaResponse>;
3437
+ /**
3438
+ * Connect a customer's own email inbox (Gmail/Outlook/IMAP) via Unipile.
3439
+ *
3440
+ * One call = one inbox. Returns a hosted-auth redirect URL; the user authes
3441
+ * there and the connect webhook creates the `ready` mailbox. Call once per
3442
+ * inbox to add multiple mailboxes.
3443
+ */
3444
+ connectInbox(request: ConnectInboxRequest): Promise<ConnectInboxResponse>;
3445
+ /**
3446
+ * Update a single mailbox's send settings (per-mailbox daily cap, pause).
3447
+ *
3448
+ * PATCH semantics — only provided fields change. The per-mailbox cap is the
3449
+ * primary lever for BYO inboxes, which skip the InboxKit warmup ramp.
3450
+ * Requires admin role on the org.
3451
+ */
3452
+ updateMailbox(orgId: string, mailboxId: string, userId: string, update: MailboxUpdateRequest): Promise<MailboxUpdateResponse>;
3390
3453
  /**
3391
3454
  * Teardown an email organization's infrastructure.
3392
3455
  *
@@ -5333,6 +5396,166 @@ declare class ModelPreferencesResource {
5333
5396
  }): Promise<TenantModelPreferencesResponse>;
5334
5397
  }
5335
5398
 
5399
+ /**
5400
+ * Outreach connections (funnel-people + stats) types.
5401
+ *
5402
+ * These map to the Python backend endpoints under /v1/outreach, which list the
5403
+ * PEOPLE behind any outreach funnel stage — connected, messaged, replied, or
5404
+ * meeting_booked — reached via Lumnis through a sequence or an AI campaign.
5405
+ */
5406
+ /** Concrete funnel stage on a per-person row. */
5407
+ type Stage = 'connected' | 'messaged' | 'replied' | 'meeting_booked';
5408
+ /** Stage filter accepted on the request (and echoed on the response). */
5409
+ type StageFilter = 'all' | 'connected' | 'messaged' | 'replied' | 'meeting_booked';
5410
+ /** Channel filter — applies to the "messaged" stage (LinkedIn DM vs InMail vs email). */
5411
+ type Channel = 'all' | 'linkedin' | 'email' | 'inmail';
5412
+ /** Which outreach system a row came from. */
5413
+ type OutreachSource = 'all' | 'sequence' | 'campaign';
5414
+ interface ListConnectionsParams {
5415
+ /** User ID or email (REQUIRED) — results are scoped to this user. */
5416
+ userId: string;
5417
+ /** Funnel stage, or 'all' for the furthest stage per person. Defaults to 'connected'. */
5418
+ stage?: StageFilter;
5419
+ /** For stage='messaged': linkedin | email | inmail | all. Defaults to 'all'. */
5420
+ channel?: Channel;
5421
+ /** Restrict to a single outreach system. Defaults to 'all'. */
5422
+ source?: OutreachSource;
5423
+ /**
5424
+ * One or more campaign IDs to filter to. When set, results are campaign-only
5425
+ * (sequences are excluded).
5426
+ */
5427
+ campaignId?: string[];
5428
+ /** Only include rows reaching the stage on/after this date (YYYY-MM-DD). */
5429
+ since?: string;
5430
+ /** Also return the per-channel funnel stats + ratios for the scope. Defaults to false. */
5431
+ stats?: boolean;
5432
+ limit?: number;
5433
+ offset?: number;
5434
+ }
5435
+ interface ListAcceptedConnectionsParams {
5436
+ /** User ID or email (REQUIRED) — results are scoped to this user. */
5437
+ userId: string;
5438
+ /** Restrict to a single outreach system. Defaults to 'all'. */
5439
+ source?: OutreachSource;
5440
+ /** One or more campaign IDs to filter to (campaign-only when set). */
5441
+ campaignId?: string[];
5442
+ /** Only include rows accepted on/after this date (YYYY-MM-DD). */
5443
+ since?: string;
5444
+ limit?: number;
5445
+ offset?: number;
5446
+ }
5447
+ /**
5448
+ * A person at a given outreach funnel stage, reached via Lumnis.
5449
+ *
5450
+ * When `stage='all'` was requested, `stage` is the FURTHEST stage this person
5451
+ * reached (meeting_booked > replied > messaged > connected) and `stageAt` is
5452
+ * that stage's timestamp.
5453
+ */
5454
+ interface Connection {
5455
+ rowId: string;
5456
+ source: 'sequence' | 'campaign';
5457
+ sourceId: string;
5458
+ sourceName?: string | null;
5459
+ userId?: string | null;
5460
+ fullName?: string | null;
5461
+ title?: string | null;
5462
+ company?: string | null;
5463
+ linkedinUrl?: string | null;
5464
+ providerId?: string | null;
5465
+ senderAccountId?: string | null;
5466
+ stage: Stage;
5467
+ stageAt?: string | null;
5468
+ }
5469
+ /**
5470
+ * Conversion ratios WITHIN one channel — all <= 1.0 (100%) by construction.
5471
+ *
5472
+ * `connectRate` / `messageRate` apply only to LinkedIn (InMail/email have no
5473
+ * connect step, so they are `null` there). `null` whenever the denominator is 0.
5474
+ */
5475
+ interface ChannelRatios {
5476
+ /** connected / connectionRequestsSent (LinkedIn only) */
5477
+ connectRate?: number | null;
5478
+ /** sent / connected (LinkedIn only) */
5479
+ messageRate?: number | null;
5480
+ /** replied / sent */
5481
+ replyRate?: number | null;
5482
+ /** meetingBooked / replied (a.k.a. book rate) */
5483
+ meetingRate?: number | null;
5484
+ }
5485
+ /**
5486
+ * One channel's funnel. For InMail/email, `connectionRequestsSent` and
5487
+ * `connected` are 0 (those channels have no connect step).
5488
+ */
5489
+ interface ChannelFunnel {
5490
+ /** LinkedIn only (0 for inmail/email). */
5491
+ connectionRequestsSent: number;
5492
+ /** LinkedIn only (0 for inmail/email). */
5493
+ connected: number;
5494
+ /** Messages sent in this channel (DMs / InMails / emails). */
5495
+ sent: number;
5496
+ replied: number;
5497
+ meetingBooked: number;
5498
+ ratios: ChannelRatios;
5499
+ }
5500
+ /**
5501
+ * Per-channel funnels, folded into the list response when `stats=true`.
5502
+ *
5503
+ * Channels are reported separately on purpose so conversion ratios stay valid.
5504
+ * Keys: 'linkedin', 'inmail', 'email'.
5505
+ */
5506
+ interface OutreachStats {
5507
+ byChannel: Record<string, ChannelFunnel>;
5508
+ }
5509
+ interface ConnectionsResponse {
5510
+ items: Connection[];
5511
+ total: number;
5512
+ stage: StageFilter;
5513
+ channel: Channel;
5514
+ limit: number;
5515
+ offset: number;
5516
+ stats?: OutreachStats | null;
5517
+ computedAt: string;
5518
+ }
5519
+
5520
+ /**
5521
+ * Resource for the outreach connections (funnel-people) API.
5522
+ *
5523
+ * Cross-system read endpoints that list the PEOPLE behind any outreach funnel
5524
+ * stage — connected (accepted a CR), messaged, replied, or meeting_booked —
5525
+ * reached via Lumnis, whether through a traditional sequence or an AI campaign.
5526
+ *
5527
+ * Wraps `GET /v1/outreach` and `GET /v1/outreach/accepted`.
5528
+ */
5529
+ declare class OutreachResource {
5530
+ private readonly http;
5531
+ constructor(http: Http);
5532
+ /**
5533
+ * List people at a funnel stage (connected/messaged/replied/meeting_booked),
5534
+ * or `stage='all'` for one row per person at their furthest stage.
5535
+ *
5536
+ * Pass `stats: true` to also get the per-channel funnel counts + conversion
5537
+ * ratios for the same scope (`userId`/`source`/`campaignId`) alongside the
5538
+ * people list. Pass `campaignId` to restrict to specific campaigns (this
5539
+ * excludes sequences).
5540
+ *
5541
+ * @example
5542
+ * ```typescript
5543
+ * const result = await client.outreach.listConnections({
5544
+ * userId: 'user@example.com',
5545
+ * stage: 'replied',
5546
+ * stats: true,
5547
+ * })
5548
+ * console.log(result.total, result.stats?.byChannel.linkedin.ratios.replyRate)
5549
+ * ```
5550
+ */
5551
+ listConnections(params: ListConnectionsParams): Promise<ConnectionsResponse>;
5552
+ /**
5553
+ * Alias for `stage='connected'` — people who accepted a Lumnis-sent
5554
+ * connection request.
5555
+ */
5556
+ listAcceptedConnections(params: ListAcceptedConnectionsParams): Promise<ConnectionsResponse>;
5557
+ }
5558
+
5336
5559
  declare class PeopleResource {
5337
5560
  private readonly http;
5338
5561
  constructor(http: Http);
@@ -6858,6 +7081,7 @@ declare class LumnisClient {
6858
7081
  readonly enrichment: EnrichmentResource;
6859
7082
  readonly email: EmailResource;
6860
7083
  readonly crm: CrmResource;
7084
+ readonly outreach: OutreachResource;
6861
7085
  private readonly _scopedUserId?;
6862
7086
  private readonly _defaultScope;
6863
7087
  constructor(options?: LumnisClientOptions);
@@ -7210,4 +7434,4 @@ declare class ProgressTracker {
7210
7434
  */
7211
7435
  declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
7212
7436
 
7213
- export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, 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, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, 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, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type 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 PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, 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, type SkippedTransferProspect, 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 TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
7437
+ export { ACTION_DELAYS, type ActionLimit, type ActiveHours, type AddAndRunCriterionRequest, type AddCriterionRequest, type AddOrgMemberRequest, type AddOrgMemberResponse, type AddPersonaRequest, type AddPersonaResponse, type AddProspectsRequest, type AddProspectsResponse, type AgentConfig, type AgentCostStats, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalActionRequest, type ApprovalItem, type ApprovalListResponse, type ApprovalMode, type ApprovalResponse, type ApprovalSettings, type ApprovalStatus, type ApprovalsParams, type ApprovalsRequestItem, type ApprovalsResponseItem, type ApproveStepRequest, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BatchCheckConnectionRequest, type BatchCheckPriorContactRequest, type BatchCheckPriorContactResponse, type BatchConnectionRequest, type BatchConnectionResponse, type BatchConnectionStatus, type BatchConnectionStatusResponse, type BatchDraftCompleteData, type BatchDraftCreatedData, type BatchDraftErrorData, type BatchDraftJobProgress, type BatchDraftJobResponse, type BatchDraftJobStartedData, type BatchDraftJobStatusResponse, type BatchDraftProgressData, type BatchDraftRequest, type BatchDraftResponse, type BatchDraftStreamCallbacks, type BatchDraftStreamEvent, type BatchDraftStreamEventType, type BatchExecutionInclude, type BatchExecutionRequest, type BatchExecutionResponse, BatchJobStatus, type BatchPollRequest, type BatchPollResponse, type BatchProspectIdentifier, type BatchRequestItem, type BatchRequestType, type BatchResponseItem, type BatchSendRequest, type BatchSendResponse, type BatchStepMetric, type BillingStatus, type BulkApprovalAction, type BulkApprovalFailure, type BulkApprovalRequest, type BulkApprovalResponse, type BulkCompleteFailure, type BulkCompleteRequest, type BulkCompleteResponse, type BulkDeleteRequest, type BulkDeleteResponse, type BulkOperationRequest, type BulkOperationResponse, type BulkUploadResponse, CONTENT_LIMITS, CONTENT_LIMITS_MAP, type CampaignActionListResponse, type CampaignActionResponse, type CampaignActionStatus, type CampaignActionType, type CampaignBulkApprovalAction, type CampaignBulkApprovalItem, type CampaignBulkApprovalRequest, type CampaignBulkApprovalResponse, type CampaignBulkApprovalResult, type CampaignCreate, type CampaignGuardrails, type CampaignListResponse, type CampaignMetricsResponse, type CampaignOutcomeType, type CampaignProspectDetailResponse, type CampaignProspectInput, type CampaignProspectResponse, type CampaignProspectState, type CampaignResponse, type CampaignStatus, type CampaignUpdate, CampaignsResource, type CancelDraftResponse, type CancelQueuedRequest, type CancelResponseResponse, type Channel, type ChannelContactHistory, type ChannelFunnel, type ChannelRatios, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompetitorPostEngagementOutput, type CompetitorRepEngagementOutput, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectInboxRequest, type ConnectInboxResponse, type Connection, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type ConnectionsResponse, type ConnectionsSyncStatus, type ContactDetailsInput, type ContactEnrichPersonInput, type ContactEnrichPersonResult, type ContactEnrichRequest, type ContactEnrichResponse, type 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, type CrmMatchBatchRequest, type CrmMatchBatchResponse, type CrmMatchedProspect, type CrmProvider, CrmResource, type CrmSyncProspectRequest, type CrmSyncProspectResponse, DAILY_INMAIL_LIMITS, DEFAULT_SUBSCRIPTION_TYPE, type DatabaseStatus, type DeepPeopleSearchOutput, type DeepSearchPreview, type DeepSearchStats, type DeleteApiKeyResponse, type DeleteConnectionsResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DiscoveryTrace, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type EditQueuedRequest, type Email, type EmailAction, type EmailOnboardRequest, type EmailOnboardResponse, type EmailOnboardStatusResponse, type EmailOrgHealthResponse, type EmailOrgListResponse, type EmailOrgSettingsResponse, type EmailOrgSettingsUpdate, type EmailOrgSummary, EmailResource, type EmailSenderPersona, 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, type IntentSignal, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkAssetsRequest, type LinkedAssetsResponse, type LinkedInAccountInfoResponse, type LinkedInAccountRateLimits, type LinkedInAccountRateLimitsResponse, type LinkedInAccountRateLimitsUpdate, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type LinkedInSyncStatusResponse, type ListAcceptedConnectionsParams, type ListApprovalsOptions, type ListAssetsOptions, type ListCampaignActionsOptions, type ListCampaignProspectsOptions, type ListCampaignsOptions, type ListConnectionsParams, type ListExecutionsOptions, type ListPendingApprovalsOptions, type ListPlaybooksOptions, type ListProvidersResponse, type ListStepExecutionsOptions, type ListTemplatesOptions, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type MailboxUpdateRequest, type MailboxUpdateResponse, type Message, type MessageReceivedData, type MessageResponse, type MessageSentData, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingResource, MessagingSendError, MessagingValidationError, type MetricsParams, type MetricsRequestItem, type MetricsResponseItem, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NetworkDistance, NoDataSourcesError, NotFoundError, type OnFailure, type OutcomeType, type OutreachAssetCreate, type OutreachAssetResponse, type OutreachAssetType, type OutreachAssetUpdate, OutreachMethod, OutreachResource, type OutreachSource, type OutreachStats, 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 PostEngagementData, type PostEngagementProvenance, type PostEngagementType, type PostPreviewRequest, type PostPreviewResponse, type PostPreviewResult, type PostsDateRange, type PostsSearchStats, type PriorContactMessage, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, type ProjectApprovalsData, type ProjectExecutionsData, type ProjectMetricsData, type ProspectConnectionCheck, type ProspectInfo, type ProspectInput, type ProspectPriorContactResult, type ProspectSyncIdentifier, type ProspectSyncResult, type ProspectWarning, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo$1 as RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RecordOutcomeRequest, type RejectActionRequest, type RejectStepRequest, type RemoveOrgMemberResponse, type RepEngagementData, type RepEngagementStats, type ReplySentiment, type ResolvedCompetitorTarget, 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, type SkippedTransferProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type Stage, type StageFilter, 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 TransferProspectsRequest, type TransferProspectsResponse, type TransferSkipReason, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, type TriggerSyncResponse, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdatePersonaRequest, type UpdatePersonaResponse, type UpdateStepExecutionRequest, type UpdateStepExecutionResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, type ValidatedCandidate, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getDefaultDailyLimits, getInmailAllowance, getLimits, getMessageLimit, getRateLimit, hasOpenProfileMessages, isRecruiterSubscription, normalizeAction, verifyWebhookSignature };
package/dist/index.mjs CHANGED
@@ -1077,6 +1077,31 @@ class EmailResource {
1077
1077
  { params: { user_id: userId } }
1078
1078
  );
1079
1079
  }
1080
+ // ==================== BYO Inboxes ====================
1081
+ /**
1082
+ * Connect a customer's own email inbox (Gmail/Outlook/IMAP) via Unipile.
1083
+ *
1084
+ * One call = one inbox. Returns a hosted-auth redirect URL; the user authes
1085
+ * there and the connect webhook creates the `ready` mailbox. Call once per
1086
+ * inbox to add multiple mailboxes.
1087
+ */
1088
+ async connectInbox(request) {
1089
+ return this.http.post("/email/inboxes/connect", request);
1090
+ }
1091
+ /**
1092
+ * Update a single mailbox's send settings (per-mailbox daily cap, pause).
1093
+ *
1094
+ * PATCH semantics — only provided fields change. The per-mailbox cap is the
1095
+ * primary lever for BYO inboxes, which skip the InboxKit warmup ramp.
1096
+ * Requires admin role on the org.
1097
+ */
1098
+ async updateMailbox(orgId, mailboxId, userId, update) {
1099
+ return this.http.patch(
1100
+ `/email/organizations/${encodeURIComponent(orgId)}/mailboxes/${encodeURIComponent(mailboxId)}`,
1101
+ update,
1102
+ { params: { user_id: userId } }
1103
+ );
1104
+ }
1080
1105
  // ==================== Teardown ====================
1081
1106
  /**
1082
1107
  * Teardown an email organization's infrastructure.
@@ -2839,6 +2864,71 @@ class ModelPreferencesResource {
2839
2864
  }
2840
2865
  }
2841
2866
 
2867
+ class OutreachResource {
2868
+ constructor(http) {
2869
+ this.http = http;
2870
+ }
2871
+ /**
2872
+ * List people at a funnel stage (connected/messaged/replied/meeting_booked),
2873
+ * or `stage='all'` for one row per person at their furthest stage.
2874
+ *
2875
+ * Pass `stats: true` to also get the per-channel funnel counts + conversion
2876
+ * ratios for the same scope (`userId`/`source`/`campaignId`) alongside the
2877
+ * people list. Pass `campaignId` to restrict to specific campaigns (this
2878
+ * excludes sequences).
2879
+ *
2880
+ * @example
2881
+ * ```typescript
2882
+ * const result = await client.outreach.listConnections({
2883
+ * userId: 'user@example.com',
2884
+ * stage: 'replied',
2885
+ * stats: true,
2886
+ * })
2887
+ * console.log(result.total, result.stats?.byChannel.linkedin.ratios.replyRate)
2888
+ * ```
2889
+ */
2890
+ async listConnections(params) {
2891
+ const query = new URLSearchParams();
2892
+ query.append("user_id", params.userId);
2893
+ if (params.stage !== void 0)
2894
+ query.append("stage", params.stage);
2895
+ if (params.channel !== void 0)
2896
+ query.append("channel", params.channel);
2897
+ if (params.source !== void 0)
2898
+ query.append("source", params.source);
2899
+ if (params.campaignId)
2900
+ params.campaignId.forEach((id) => query.append("campaign_id", id));
2901
+ if (params.since !== void 0)
2902
+ query.append("since", params.since);
2903
+ if (params.stats !== void 0)
2904
+ query.append("stats", String(params.stats));
2905
+ if (params.limit !== void 0)
2906
+ query.append("limit", String(params.limit));
2907
+ if (params.offset !== void 0)
2908
+ query.append("offset", String(params.offset));
2909
+ return this.http.get(`/outreach?${query.toString()}`);
2910
+ }
2911
+ /**
2912
+ * Alias for `stage='connected'` — people who accepted a Lumnis-sent
2913
+ * connection request.
2914
+ */
2915
+ async listAcceptedConnections(params) {
2916
+ const query = new URLSearchParams();
2917
+ query.append("user_id", params.userId);
2918
+ if (params.source !== void 0)
2919
+ query.append("source", params.source);
2920
+ if (params.campaignId)
2921
+ params.campaignId.forEach((id) => query.append("campaign_id", id));
2922
+ if (params.since !== void 0)
2923
+ query.append("since", params.since);
2924
+ if (params.limit !== void 0)
2925
+ query.append("limit", String(params.limit));
2926
+ if (params.offset !== void 0)
2927
+ query.append("offset", String(params.offset));
2928
+ return this.http.get(`/outreach/accepted?${query.toString()}`);
2929
+ }
2930
+ }
2931
+
2842
2932
  var PeopleDataSource = /* @__PURE__ */ ((PeopleDataSource2) => {
2843
2933
  PeopleDataSource2["PDL"] = "PDL";
2844
2934
  PeopleDataSource2["CORESIGNAL"] = "CORESIGNAL";
@@ -4614,6 +4704,7 @@ class LumnisClient {
4614
4704
  enrichment;
4615
4705
  email;
4616
4706
  crm;
4707
+ outreach;
4617
4708
  _scopedUserId;
4618
4709
  _defaultScope;
4619
4710
  constructor(options = {}) {
@@ -4652,6 +4743,7 @@ class LumnisClient {
4652
4743
  this.enrichment = new EnrichmentResource(this.http);
4653
4744
  this.email = new EmailResource(this.http);
4654
4745
  this.crm = new CrmResource(this.http);
4746
+ this.outreach = new OutreachResource(this.http);
4655
4747
  }
4656
4748
  forUser(userId) {
4657
4749
  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.23",
4
+ "version": "0.5.24",
5
5
  "description": "Official Node.js SDK for the Lumnis AI API",
6
6
  "author": "Lumnis AI",
7
7
  "license": "MIT",