lumnisai 0.2.16 → 0.2.18
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 +50 -0
- package/dist/index.d.cts +144 -2
- package/dist/index.d.mts +144 -2
- package/dist/index.d.ts +144 -2
- package/dist/index.mjs +48 -1
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -224,6 +224,22 @@ const ACTION_DELAYS = {
|
|
|
224
224
|
betweenProfileViews: 5,
|
|
225
225
|
afterError: 60
|
|
226
226
|
};
|
|
227
|
+
const DAILY_INMAIL_LIMITS = {
|
|
228
|
+
basic: 0,
|
|
229
|
+
// No InMail capability
|
|
230
|
+
premium: 5,
|
|
231
|
+
// 5 credits/month - can send all in one day if desired
|
|
232
|
+
premium_career: 5,
|
|
233
|
+
// Same as premium
|
|
234
|
+
premium_business: 15,
|
|
235
|
+
// 15 credits/month
|
|
236
|
+
sales_navigator: 50,
|
|
237
|
+
// 50 credits/month
|
|
238
|
+
recruiter_lite: 100,
|
|
239
|
+
// 30 InMails + up to 100 Open Profile/month
|
|
240
|
+
recruiter_corporate: 1e3
|
|
241
|
+
// LinkedIn official: 1,000/day per seat
|
|
242
|
+
};
|
|
227
243
|
function getLimits(subscriptionType) {
|
|
228
244
|
const type = subscriptionType || "basic";
|
|
229
245
|
return LINKEDIN_LIMITS[type] || LINKEDIN_LIMITS.basic;
|
|
@@ -268,6 +284,13 @@ function getBestSubscriptionForAction(subscriptionTypes, action) {
|
|
|
268
284
|
}
|
|
269
285
|
return subscriptionTypes[0];
|
|
270
286
|
}
|
|
287
|
+
function getDailyInmailLimit(subscriptionType) {
|
|
288
|
+
const type = subscriptionType || "basic";
|
|
289
|
+
return DAILY_INMAIL_LIMITS[type] ?? DAILY_INMAIL_LIMITS.basic;
|
|
290
|
+
}
|
|
291
|
+
function isRecruiterSubscription(subscriptionType) {
|
|
292
|
+
return subscriptionType === "recruiter_lite" || subscriptionType === "recruiter_corporate";
|
|
293
|
+
}
|
|
271
294
|
|
|
272
295
|
const CONTENT_LIMITS = [
|
|
273
296
|
{ channel: "linkedin", action: "connection_request", maxCharacters: 300 },
|
|
@@ -2337,6 +2360,30 @@ class ResponsesResource {
|
|
|
2337
2360
|
params.excludePreviouslyContacted = options.excludePreviouslyContacted;
|
|
2338
2361
|
if (options.excludeNames)
|
|
2339
2362
|
params.excludeNames = options.excludeNames;
|
|
2363
|
+
if (options.searchProfiles !== void 0)
|
|
2364
|
+
params.searchProfiles = options.searchProfiles;
|
|
2365
|
+
if (options.searchPosts !== void 0)
|
|
2366
|
+
params.searchPosts = options.searchPosts;
|
|
2367
|
+
if (options.includeEngagementInScore !== void 0)
|
|
2368
|
+
params.includeEngagementInScore = options.includeEngagementInScore;
|
|
2369
|
+
if (options.postsMaxResults !== void 0)
|
|
2370
|
+
params.postsMaxResults = options.postsMaxResults;
|
|
2371
|
+
if (options.postsMaxKeywords !== void 0)
|
|
2372
|
+
params.postsMaxKeywords = options.postsMaxKeywords;
|
|
2373
|
+
if (options.postsDateRange)
|
|
2374
|
+
params.postsDateRange = options.postsDateRange;
|
|
2375
|
+
if (options.postsFields)
|
|
2376
|
+
params.postsFields = options.postsFields;
|
|
2377
|
+
if (options.postsMaxReactors !== void 0)
|
|
2378
|
+
params.postsMaxReactors = options.postsMaxReactors;
|
|
2379
|
+
if (options.postsMaxComments !== void 0)
|
|
2380
|
+
params.postsMaxComments = options.postsMaxComments;
|
|
2381
|
+
if (options.postsEnableEnrichment !== void 0)
|
|
2382
|
+
params.postsEnableEnrichment = options.postsEnableEnrichment;
|
|
2383
|
+
if (options.postsEnableFiltering !== void 0)
|
|
2384
|
+
params.postsEnableFiltering = options.postsEnableFiltering;
|
|
2385
|
+
if (options.engagementScoreWeight !== void 0)
|
|
2386
|
+
params.engagementScoreWeight = options.engagementScoreWeight;
|
|
2340
2387
|
if (Object.keys(params).length > 0)
|
|
2341
2388
|
request.specializedAgentParams = params;
|
|
2342
2389
|
}
|
|
@@ -3778,6 +3825,7 @@ exports.CONTENT_LIMITS = CONTENT_LIMITS;
|
|
|
3778
3825
|
exports.CONTENT_LIMITS_MAP = CONTENT_LIMITS_MAP;
|
|
3779
3826
|
exports.ChannelType = ChannelType;
|
|
3780
3827
|
exports.ConversationStatus = ConversationStatus;
|
|
3828
|
+
exports.DAILY_INMAIL_LIMITS = DAILY_INMAIL_LIMITS;
|
|
3781
3829
|
exports.DraftStatus = DraftStatus;
|
|
3782
3830
|
exports.InternalServerError = InternalServerError;
|
|
3783
3831
|
exports.LINKEDIN_LIMITS = LINKEDIN_LIMITS;
|
|
@@ -3814,8 +3862,10 @@ exports.formatProgressEntry = formatProgressEntry;
|
|
|
3814
3862
|
exports.getBestSubscriptionForAction = getBestSubscriptionForAction;
|
|
3815
3863
|
exports.getConnectionRequestLimit = getConnectionRequestLimit;
|
|
3816
3864
|
exports.getContentLimit = getContentLimit;
|
|
3865
|
+
exports.getDailyInmailLimit = getDailyInmailLimit;
|
|
3817
3866
|
exports.getInmailAllowance = getInmailAllowance;
|
|
3818
3867
|
exports.getLimits = getLimits;
|
|
3819
3868
|
exports.getMessageLimit = getMessageLimit;
|
|
3820
3869
|
exports.hasOpenProfileMessages = hasOpenProfileMessages;
|
|
3870
|
+
exports.isRecruiterSubscription = isRecruiterSubscription;
|
|
3821
3871
|
exports.verifyWebhookSignature = verifyWebhookSignature;
|
package/dist/index.d.cts
CHANGED
|
@@ -85,6 +85,21 @@ declare const ACTION_DELAYS: {
|
|
|
85
85
|
readonly betweenProfileViews: 5;
|
|
86
86
|
readonly afterError: 60;
|
|
87
87
|
};
|
|
88
|
+
/**
|
|
89
|
+
* Daily InMail sending limits by subscription type.
|
|
90
|
+
*
|
|
91
|
+
* These are the maximum InMails you can SEND per day (rate limit), separate from
|
|
92
|
+
* the monthly credits you have available.
|
|
93
|
+
*
|
|
94
|
+
* Per LinkedIn official documentation (https://www.linkedin.com/help/recruiter/answer/a745199):
|
|
95
|
+
* - Recruiter Corporate/RPS: 1,000 InMails per day per seat
|
|
96
|
+
* - Recruiter Lite: Limited by monthly credits (30/month + 100 Open Profile/month)
|
|
97
|
+
* - Other tiers: No official daily limit, but limited by monthly credits
|
|
98
|
+
*
|
|
99
|
+
* For non-Recruiter accounts, we set daily limit = monthly credits to allow
|
|
100
|
+
* flexibility while still respecting credit availability.
|
|
101
|
+
*/
|
|
102
|
+
declare const DAILY_INMAIL_LIMITS: Record<LinkedInLimitSubscriptionType, number>;
|
|
88
103
|
/**
|
|
89
104
|
* Get all limits for a subscription type
|
|
90
105
|
*/
|
|
@@ -121,6 +136,27 @@ declare function hasOpenProfileMessages(subscriptionType: LinkedInLimitSubscript
|
|
|
121
136
|
* - Other actions: recruiter_corporate > sales_navigator > recruiter_lite > premium_business > premium_career > basic
|
|
122
137
|
*/
|
|
123
138
|
declare function getBestSubscriptionForAction(subscriptionTypes: (LinkedInLimitSubscriptionType | string)[], action: 'inmail' | 'connection_requests' | 'messages'): LinkedInLimitSubscriptionType | string | null;
|
|
139
|
+
/**
|
|
140
|
+
* Get daily InMail sending limit for a subscription type.
|
|
141
|
+
*
|
|
142
|
+
* Per LinkedIn official documentation:
|
|
143
|
+
* - Recruiter Corporate: 1,000 InMails per day per seat
|
|
144
|
+
* - Recruiter Lite: ~100/day (30 regular + 100 Open Profile per month)
|
|
145
|
+
* - Other tiers: Limited by monthly credits
|
|
146
|
+
*
|
|
147
|
+
* Note: This is the daily SENDING rate limit, not the total credits available.
|
|
148
|
+
* Credits are still consumed per InMail sent.
|
|
149
|
+
*/
|
|
150
|
+
declare function getDailyInmailLimit(subscriptionType: LinkedInLimitSubscriptionType | string | null | undefined): number;
|
|
151
|
+
/**
|
|
152
|
+
* Check if subscription type is a Recruiter subscription.
|
|
153
|
+
*
|
|
154
|
+
* Recruiter subscriptions have special privileges:
|
|
155
|
+
* - High daily InMail limits (up to 1,000/day for Corporate)
|
|
156
|
+
* - Access to Recruiter API features
|
|
157
|
+
* - Open Profile messaging (free InMails to open profiles)
|
|
158
|
+
*/
|
|
159
|
+
declare function isRecruiterSubscription(subscriptionType: LinkedInLimitSubscriptionType | string | null | undefined): boolean;
|
|
124
160
|
|
|
125
161
|
interface ContentLimit {
|
|
126
162
|
channel: string;
|
|
@@ -192,7 +228,7 @@ interface TenantDetailsResponse {
|
|
|
192
228
|
updatedAt: string;
|
|
193
229
|
}
|
|
194
230
|
|
|
195
|
-
type ApiProvider = 'OPENAI_API_KEY' | 'ANTHROPIC_API_KEY' | 'EXA_API_KEY' | 'COHERE_API_KEY' | 'CORESIGNAL_API_KEY' | 'GOOGLE_API_KEY' | 'SERPAPI_API_KEY' | 'GROQ_API_KEY' | 'NVIDIA_API_KEY' | 'FIREWORKS_API_KEY' | 'MISTRAL_API_KEY' | 'TOGETHER_API_KEY' | 'XAI_API_KEY' | 'PPLX_API_KEY' | 'HUGGINGFACE_API_KEY' | 'DEEPSEEK_API_KEY' | 'IBM_API_KEY' | 'E2B_API_KEY';
|
|
231
|
+
type ApiProvider = 'OPENAI_API_KEY' | 'ANTHROPIC_API_KEY' | 'EXA_API_KEY' | 'COHERE_API_KEY' | 'CORESIGNAL_API_KEY' | 'GOOGLE_API_KEY' | 'SERPAPI_API_KEY' | 'GROQ_API_KEY' | 'NVIDIA_API_KEY' | 'FIREWORKS_API_KEY' | 'MISTRAL_API_KEY' | 'TOGETHER_API_KEY' | 'XAI_API_KEY' | 'PPLX_API_KEY' | 'HUGGINGFACE_API_KEY' | 'DEEPSEEK_API_KEY' | 'IBM_API_KEY' | 'PDL_API_KEY' | 'CRUSTDATA_API_KEY' | 'ENRICH_LAYER_API_KEY' | 'E2B_API_KEY' | 'AWS_ACCESS_KEY_ID' | 'AWS_SECRET_ACCESS_KEY';
|
|
196
232
|
interface StoreApiKeyRequest {
|
|
197
233
|
provider: ApiProvider;
|
|
198
234
|
apiKey: string;
|
|
@@ -767,6 +803,94 @@ interface SpecializedAgentParams {
|
|
|
767
803
|
* Each candidate must include at least one identifier: linkedin_url or email/emails.
|
|
768
804
|
*/
|
|
769
805
|
candidateProfiles?: Array<Record<string, any>>;
|
|
806
|
+
/**
|
|
807
|
+
* Whether to search profile databases (CrustData/PDL).
|
|
808
|
+
* Options: true (always), false (never), 'auto' (LLM decides).
|
|
809
|
+
* @default true
|
|
810
|
+
* Used by deep_people_search.
|
|
811
|
+
*/
|
|
812
|
+
searchProfiles?: boolean | 'auto';
|
|
813
|
+
/**
|
|
814
|
+
* Whether to search LinkedIn posts for engagement (authors, reactors, commenters).
|
|
815
|
+
* Options: true (always), false (never), 'auto' (LLM decides based on query).
|
|
816
|
+
* @default 'auto'
|
|
817
|
+
* Used by deep_people_search.
|
|
818
|
+
*/
|
|
819
|
+
searchPosts?: boolean | 'auto';
|
|
820
|
+
/**
|
|
821
|
+
* Whether to include LinkedIn post engagement in candidate scoring.
|
|
822
|
+
* Options: true (always), false (never), 'auto' (LLM decides).
|
|
823
|
+
* @default 'auto'
|
|
824
|
+
* Used by deep_people_search.
|
|
825
|
+
*/
|
|
826
|
+
includeEngagementInScore?: boolean | 'auto';
|
|
827
|
+
/**
|
|
828
|
+
* Maximum number of posts to search.
|
|
829
|
+
* Range: 1-500
|
|
830
|
+
* @default 50
|
|
831
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
832
|
+
*/
|
|
833
|
+
postsMaxResults?: number;
|
|
834
|
+
/**
|
|
835
|
+
* Maximum number of keywords to use for posts search.
|
|
836
|
+
* If not provided, all extracted keywords are used.
|
|
837
|
+
* Range: 1-20
|
|
838
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
839
|
+
*/
|
|
840
|
+
postsMaxKeywords?: number;
|
|
841
|
+
/**
|
|
842
|
+
* Date range for posts search.
|
|
843
|
+
* Options: 'past-24h', 'past-week', 'past-month', 'past-year'
|
|
844
|
+
* @default 'past-month'
|
|
845
|
+
* Used by deep_people_search.
|
|
846
|
+
*/
|
|
847
|
+
postsDateRange?: 'past-24h' | 'past-week' | 'past-month' | 'past-year';
|
|
848
|
+
/**
|
|
849
|
+
* Engagement fields to fetch from posts.
|
|
850
|
+
* Options: 'reactors' (5 credits/post), 'comments' (5 credits/post), 'reactors,comments' (10 credits/post)
|
|
851
|
+
* @default 'reactors'
|
|
852
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
853
|
+
*/
|
|
854
|
+
postsFields?: 'reactors' | 'comments' | 'reactors,comments';
|
|
855
|
+
/**
|
|
856
|
+
* Maximum reactors per post to fetch.
|
|
857
|
+
* Range: 1-5000
|
|
858
|
+
* @default 5000
|
|
859
|
+
* No additional cost (same 5 credits/post for 1-5000 reactors).
|
|
860
|
+
* Used by deep_people_search when postsFields includes 'reactors'.
|
|
861
|
+
*/
|
|
862
|
+
postsMaxReactors?: number;
|
|
863
|
+
/**
|
|
864
|
+
* Maximum comments per post to fetch.
|
|
865
|
+
* Range: 1-5000
|
|
866
|
+
* @default 5000
|
|
867
|
+
* No additional cost (same 5 credits/post for 1-5000 comments).
|
|
868
|
+
* Used by deep_people_search when postsFields includes 'comments'.
|
|
869
|
+
*/
|
|
870
|
+
postsMaxComments?: number;
|
|
871
|
+
/**
|
|
872
|
+
* Whether to enrich posts candidates with EnrichLayer.
|
|
873
|
+
* @default false
|
|
874
|
+
* CrustData posts API already provides rich data (skills, experience, education).
|
|
875
|
+
* Enable only if you need additional fields from EnrichLayer.
|
|
876
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
877
|
+
*/
|
|
878
|
+
postsEnableEnrichment?: boolean;
|
|
879
|
+
/**
|
|
880
|
+
* Whether to filter posts for relevance before extracting people.
|
|
881
|
+
* @default true
|
|
882
|
+
* Uses LLM to identify and skip hiring posts, spam, and irrelevant content.
|
|
883
|
+
* Improves candidate quality at cost of ~1 LLM call per post.
|
|
884
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
885
|
+
*/
|
|
886
|
+
postsEnableFiltering?: boolean;
|
|
887
|
+
/**
|
|
888
|
+
* Weight for engagement score when included in match score calculation.
|
|
889
|
+
* Range: 0.0-0.3
|
|
890
|
+
* @default 0.15
|
|
891
|
+
* Used by deep_people_search when includeEngagementInScore is true.
|
|
892
|
+
*/
|
|
893
|
+
engagementScoreWeight?: number;
|
|
770
894
|
/**
|
|
771
895
|
* Additional parameters for any specialized agent
|
|
772
896
|
* This allows flexibility for future agents without SDK updates
|
|
@@ -1939,6 +2063,12 @@ interface LinkedInAccountInfoResponse {
|
|
|
1939
2063
|
connectionRequestsSentToday?: number | null;
|
|
1940
2064
|
gmailSentToday?: number | null;
|
|
1941
2065
|
outlookSentToday?: number | null;
|
|
2066
|
+
inmailDailyLimit?: number | null;
|
|
2067
|
+
directMessageDailyLimit?: number | null;
|
|
2068
|
+
connectionRequestDailyLimit?: number | null;
|
|
2069
|
+
inmailRemainingToday?: number | null;
|
|
2070
|
+
directMessagesRemainingToday?: number | null;
|
|
2071
|
+
connectionRequestsRemainingToday?: number | null;
|
|
1942
2072
|
unipileStatus?: string | null;
|
|
1943
2073
|
}
|
|
1944
2074
|
/**
|
|
@@ -3013,6 +3143,18 @@ declare class ResponsesResource {
|
|
|
3013
3143
|
excludeProfiles?: string[];
|
|
3014
3144
|
excludePreviouslyContacted?: boolean;
|
|
3015
3145
|
excludeNames?: string[];
|
|
3146
|
+
searchProfiles?: boolean | 'auto';
|
|
3147
|
+
searchPosts?: boolean | 'auto';
|
|
3148
|
+
includeEngagementInScore?: boolean | 'auto';
|
|
3149
|
+
postsMaxResults?: number;
|
|
3150
|
+
postsMaxKeywords?: number;
|
|
3151
|
+
postsDateRange?: 'past-24h' | 'past-week' | 'past-month' | 'past-year';
|
|
3152
|
+
postsFields?: 'reactors' | 'comments' | 'reactors,comments';
|
|
3153
|
+
postsMaxReactors?: number;
|
|
3154
|
+
postsMaxComments?: number;
|
|
3155
|
+
postsEnableEnrichment?: boolean;
|
|
3156
|
+
postsEnableFiltering?: boolean;
|
|
3157
|
+
engagementScoreWeight?: number;
|
|
3016
3158
|
}): Promise<CreateResponseResponse>;
|
|
3017
3159
|
/**
|
|
3018
3160
|
* Score provided candidates against AI-generated or provided criteria
|
|
@@ -4388,4 +4530,4 @@ declare class ProgressTracker {
|
|
|
4388
4530
|
*/
|
|
4389
4531
|
declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
|
|
4390
4532
|
|
|
4391
|
-
export { ACTION_DELAYS, type ActionLimit, type AddAndRunCriterionRequest, type AddCriterionRequest, type AgentConfig, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalItem, type ApprovalListResponse, type ApprovalResponse, 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 CancelDraftResponse, type CancelResponseResponse, type ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type 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 CriterionType, type DatabaseStatus, type DeleteApiKeyResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type Email, type EmailAction, type EmailThreadSummary, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, 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 GetConnectionStatusParams, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkedInAccountInfoResponse, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type ListApprovalsOptions, type ListExecutionsOptions, type ListProvidersResponse, 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, OutreachMethod, type PaginationInfo, type PaginationParams, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, 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, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RejectStepRequest, type ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type 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 SkipStepRequest, type SkipStepResponse, type SkippedProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getInmailAllowance, getLimits, getMessageLimit, hasOpenProfileMessages, verifyWebhookSignature };
|
|
4533
|
+
export { ACTION_DELAYS, type ActionLimit, type AddAndRunCriterionRequest, type AddCriterionRequest, type AgentConfig, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalItem, type ApprovalListResponse, type ApprovalResponse, 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 CancelDraftResponse, type CancelResponseResponse, type ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type 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 CriterionType, DAILY_INMAIL_LIMITS, type DatabaseStatus, type DeleteApiKeyResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type Email, type EmailAction, type EmailThreadSummary, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, 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 GetConnectionStatusParams, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkedInAccountInfoResponse, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type ListApprovalsOptions, type ListExecutionsOptions, type ListProvidersResponse, 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, OutreachMethod, type PaginationInfo, type PaginationParams, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, 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, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RejectStepRequest, type ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type 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 SkipStepRequest, type SkipStepResponse, type SkippedProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getInmailAllowance, getLimits, getMessageLimit, hasOpenProfileMessages, isRecruiterSubscription, verifyWebhookSignature };
|
package/dist/index.d.mts
CHANGED
|
@@ -85,6 +85,21 @@ declare const ACTION_DELAYS: {
|
|
|
85
85
|
readonly betweenProfileViews: 5;
|
|
86
86
|
readonly afterError: 60;
|
|
87
87
|
};
|
|
88
|
+
/**
|
|
89
|
+
* Daily InMail sending limits by subscription type.
|
|
90
|
+
*
|
|
91
|
+
* These are the maximum InMails you can SEND per day (rate limit), separate from
|
|
92
|
+
* the monthly credits you have available.
|
|
93
|
+
*
|
|
94
|
+
* Per LinkedIn official documentation (https://www.linkedin.com/help/recruiter/answer/a745199):
|
|
95
|
+
* - Recruiter Corporate/RPS: 1,000 InMails per day per seat
|
|
96
|
+
* - Recruiter Lite: Limited by monthly credits (30/month + 100 Open Profile/month)
|
|
97
|
+
* - Other tiers: No official daily limit, but limited by monthly credits
|
|
98
|
+
*
|
|
99
|
+
* For non-Recruiter accounts, we set daily limit = monthly credits to allow
|
|
100
|
+
* flexibility while still respecting credit availability.
|
|
101
|
+
*/
|
|
102
|
+
declare const DAILY_INMAIL_LIMITS: Record<LinkedInLimitSubscriptionType, number>;
|
|
88
103
|
/**
|
|
89
104
|
* Get all limits for a subscription type
|
|
90
105
|
*/
|
|
@@ -121,6 +136,27 @@ declare function hasOpenProfileMessages(subscriptionType: LinkedInLimitSubscript
|
|
|
121
136
|
* - Other actions: recruiter_corporate > sales_navigator > recruiter_lite > premium_business > premium_career > basic
|
|
122
137
|
*/
|
|
123
138
|
declare function getBestSubscriptionForAction(subscriptionTypes: (LinkedInLimitSubscriptionType | string)[], action: 'inmail' | 'connection_requests' | 'messages'): LinkedInLimitSubscriptionType | string | null;
|
|
139
|
+
/**
|
|
140
|
+
* Get daily InMail sending limit for a subscription type.
|
|
141
|
+
*
|
|
142
|
+
* Per LinkedIn official documentation:
|
|
143
|
+
* - Recruiter Corporate: 1,000 InMails per day per seat
|
|
144
|
+
* - Recruiter Lite: ~100/day (30 regular + 100 Open Profile per month)
|
|
145
|
+
* - Other tiers: Limited by monthly credits
|
|
146
|
+
*
|
|
147
|
+
* Note: This is the daily SENDING rate limit, not the total credits available.
|
|
148
|
+
* Credits are still consumed per InMail sent.
|
|
149
|
+
*/
|
|
150
|
+
declare function getDailyInmailLimit(subscriptionType: LinkedInLimitSubscriptionType | string | null | undefined): number;
|
|
151
|
+
/**
|
|
152
|
+
* Check if subscription type is a Recruiter subscription.
|
|
153
|
+
*
|
|
154
|
+
* Recruiter subscriptions have special privileges:
|
|
155
|
+
* - High daily InMail limits (up to 1,000/day for Corporate)
|
|
156
|
+
* - Access to Recruiter API features
|
|
157
|
+
* - Open Profile messaging (free InMails to open profiles)
|
|
158
|
+
*/
|
|
159
|
+
declare function isRecruiterSubscription(subscriptionType: LinkedInLimitSubscriptionType | string | null | undefined): boolean;
|
|
124
160
|
|
|
125
161
|
interface ContentLimit {
|
|
126
162
|
channel: string;
|
|
@@ -192,7 +228,7 @@ interface TenantDetailsResponse {
|
|
|
192
228
|
updatedAt: string;
|
|
193
229
|
}
|
|
194
230
|
|
|
195
|
-
type ApiProvider = 'OPENAI_API_KEY' | 'ANTHROPIC_API_KEY' | 'EXA_API_KEY' | 'COHERE_API_KEY' | 'CORESIGNAL_API_KEY' | 'GOOGLE_API_KEY' | 'SERPAPI_API_KEY' | 'GROQ_API_KEY' | 'NVIDIA_API_KEY' | 'FIREWORKS_API_KEY' | 'MISTRAL_API_KEY' | 'TOGETHER_API_KEY' | 'XAI_API_KEY' | 'PPLX_API_KEY' | 'HUGGINGFACE_API_KEY' | 'DEEPSEEK_API_KEY' | 'IBM_API_KEY' | 'E2B_API_KEY';
|
|
231
|
+
type ApiProvider = 'OPENAI_API_KEY' | 'ANTHROPIC_API_KEY' | 'EXA_API_KEY' | 'COHERE_API_KEY' | 'CORESIGNAL_API_KEY' | 'GOOGLE_API_KEY' | 'SERPAPI_API_KEY' | 'GROQ_API_KEY' | 'NVIDIA_API_KEY' | 'FIREWORKS_API_KEY' | 'MISTRAL_API_KEY' | 'TOGETHER_API_KEY' | 'XAI_API_KEY' | 'PPLX_API_KEY' | 'HUGGINGFACE_API_KEY' | 'DEEPSEEK_API_KEY' | 'IBM_API_KEY' | 'PDL_API_KEY' | 'CRUSTDATA_API_KEY' | 'ENRICH_LAYER_API_KEY' | 'E2B_API_KEY' | 'AWS_ACCESS_KEY_ID' | 'AWS_SECRET_ACCESS_KEY';
|
|
196
232
|
interface StoreApiKeyRequest {
|
|
197
233
|
provider: ApiProvider;
|
|
198
234
|
apiKey: string;
|
|
@@ -767,6 +803,94 @@ interface SpecializedAgentParams {
|
|
|
767
803
|
* Each candidate must include at least one identifier: linkedin_url or email/emails.
|
|
768
804
|
*/
|
|
769
805
|
candidateProfiles?: Array<Record<string, any>>;
|
|
806
|
+
/**
|
|
807
|
+
* Whether to search profile databases (CrustData/PDL).
|
|
808
|
+
* Options: true (always), false (never), 'auto' (LLM decides).
|
|
809
|
+
* @default true
|
|
810
|
+
* Used by deep_people_search.
|
|
811
|
+
*/
|
|
812
|
+
searchProfiles?: boolean | 'auto';
|
|
813
|
+
/**
|
|
814
|
+
* Whether to search LinkedIn posts for engagement (authors, reactors, commenters).
|
|
815
|
+
* Options: true (always), false (never), 'auto' (LLM decides based on query).
|
|
816
|
+
* @default 'auto'
|
|
817
|
+
* Used by deep_people_search.
|
|
818
|
+
*/
|
|
819
|
+
searchPosts?: boolean | 'auto';
|
|
820
|
+
/**
|
|
821
|
+
* Whether to include LinkedIn post engagement in candidate scoring.
|
|
822
|
+
* Options: true (always), false (never), 'auto' (LLM decides).
|
|
823
|
+
* @default 'auto'
|
|
824
|
+
* Used by deep_people_search.
|
|
825
|
+
*/
|
|
826
|
+
includeEngagementInScore?: boolean | 'auto';
|
|
827
|
+
/**
|
|
828
|
+
* Maximum number of posts to search.
|
|
829
|
+
* Range: 1-500
|
|
830
|
+
* @default 50
|
|
831
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
832
|
+
*/
|
|
833
|
+
postsMaxResults?: number;
|
|
834
|
+
/**
|
|
835
|
+
* Maximum number of keywords to use for posts search.
|
|
836
|
+
* If not provided, all extracted keywords are used.
|
|
837
|
+
* Range: 1-20
|
|
838
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
839
|
+
*/
|
|
840
|
+
postsMaxKeywords?: number;
|
|
841
|
+
/**
|
|
842
|
+
* Date range for posts search.
|
|
843
|
+
* Options: 'past-24h', 'past-week', 'past-month', 'past-year'
|
|
844
|
+
* @default 'past-month'
|
|
845
|
+
* Used by deep_people_search.
|
|
846
|
+
*/
|
|
847
|
+
postsDateRange?: 'past-24h' | 'past-week' | 'past-month' | 'past-year';
|
|
848
|
+
/**
|
|
849
|
+
* Engagement fields to fetch from posts.
|
|
850
|
+
* Options: 'reactors' (5 credits/post), 'comments' (5 credits/post), 'reactors,comments' (10 credits/post)
|
|
851
|
+
* @default 'reactors'
|
|
852
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
853
|
+
*/
|
|
854
|
+
postsFields?: 'reactors' | 'comments' | 'reactors,comments';
|
|
855
|
+
/**
|
|
856
|
+
* Maximum reactors per post to fetch.
|
|
857
|
+
* Range: 1-5000
|
|
858
|
+
* @default 5000
|
|
859
|
+
* No additional cost (same 5 credits/post for 1-5000 reactors).
|
|
860
|
+
* Used by deep_people_search when postsFields includes 'reactors'.
|
|
861
|
+
*/
|
|
862
|
+
postsMaxReactors?: number;
|
|
863
|
+
/**
|
|
864
|
+
* Maximum comments per post to fetch.
|
|
865
|
+
* Range: 1-5000
|
|
866
|
+
* @default 5000
|
|
867
|
+
* No additional cost (same 5 credits/post for 1-5000 comments).
|
|
868
|
+
* Used by deep_people_search when postsFields includes 'comments'.
|
|
869
|
+
*/
|
|
870
|
+
postsMaxComments?: number;
|
|
871
|
+
/**
|
|
872
|
+
* Whether to enrich posts candidates with EnrichLayer.
|
|
873
|
+
* @default false
|
|
874
|
+
* CrustData posts API already provides rich data (skills, experience, education).
|
|
875
|
+
* Enable only if you need additional fields from EnrichLayer.
|
|
876
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
877
|
+
*/
|
|
878
|
+
postsEnableEnrichment?: boolean;
|
|
879
|
+
/**
|
|
880
|
+
* Whether to filter posts for relevance before extracting people.
|
|
881
|
+
* @default true
|
|
882
|
+
* Uses LLM to identify and skip hiring posts, spam, and irrelevant content.
|
|
883
|
+
* Improves candidate quality at cost of ~1 LLM call per post.
|
|
884
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
885
|
+
*/
|
|
886
|
+
postsEnableFiltering?: boolean;
|
|
887
|
+
/**
|
|
888
|
+
* Weight for engagement score when included in match score calculation.
|
|
889
|
+
* Range: 0.0-0.3
|
|
890
|
+
* @default 0.15
|
|
891
|
+
* Used by deep_people_search when includeEngagementInScore is true.
|
|
892
|
+
*/
|
|
893
|
+
engagementScoreWeight?: number;
|
|
770
894
|
/**
|
|
771
895
|
* Additional parameters for any specialized agent
|
|
772
896
|
* This allows flexibility for future agents without SDK updates
|
|
@@ -1939,6 +2063,12 @@ interface LinkedInAccountInfoResponse {
|
|
|
1939
2063
|
connectionRequestsSentToday?: number | null;
|
|
1940
2064
|
gmailSentToday?: number | null;
|
|
1941
2065
|
outlookSentToday?: number | null;
|
|
2066
|
+
inmailDailyLimit?: number | null;
|
|
2067
|
+
directMessageDailyLimit?: number | null;
|
|
2068
|
+
connectionRequestDailyLimit?: number | null;
|
|
2069
|
+
inmailRemainingToday?: number | null;
|
|
2070
|
+
directMessagesRemainingToday?: number | null;
|
|
2071
|
+
connectionRequestsRemainingToday?: number | null;
|
|
1942
2072
|
unipileStatus?: string | null;
|
|
1943
2073
|
}
|
|
1944
2074
|
/**
|
|
@@ -3013,6 +3143,18 @@ declare class ResponsesResource {
|
|
|
3013
3143
|
excludeProfiles?: string[];
|
|
3014
3144
|
excludePreviouslyContacted?: boolean;
|
|
3015
3145
|
excludeNames?: string[];
|
|
3146
|
+
searchProfiles?: boolean | 'auto';
|
|
3147
|
+
searchPosts?: boolean | 'auto';
|
|
3148
|
+
includeEngagementInScore?: boolean | 'auto';
|
|
3149
|
+
postsMaxResults?: number;
|
|
3150
|
+
postsMaxKeywords?: number;
|
|
3151
|
+
postsDateRange?: 'past-24h' | 'past-week' | 'past-month' | 'past-year';
|
|
3152
|
+
postsFields?: 'reactors' | 'comments' | 'reactors,comments';
|
|
3153
|
+
postsMaxReactors?: number;
|
|
3154
|
+
postsMaxComments?: number;
|
|
3155
|
+
postsEnableEnrichment?: boolean;
|
|
3156
|
+
postsEnableFiltering?: boolean;
|
|
3157
|
+
engagementScoreWeight?: number;
|
|
3016
3158
|
}): Promise<CreateResponseResponse>;
|
|
3017
3159
|
/**
|
|
3018
3160
|
* Score provided candidates against AI-generated or provided criteria
|
|
@@ -4388,4 +4530,4 @@ declare class ProgressTracker {
|
|
|
4388
4530
|
*/
|
|
4389
4531
|
declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
|
|
4390
4532
|
|
|
4391
|
-
export { ACTION_DELAYS, type ActionLimit, type AddAndRunCriterionRequest, type AddCriterionRequest, type AgentConfig, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalItem, type ApprovalListResponse, type ApprovalResponse, 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 CancelDraftResponse, type CancelResponseResponse, type ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type 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 CriterionType, type DatabaseStatus, type DeleteApiKeyResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type Email, type EmailAction, type EmailThreadSummary, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, 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 GetConnectionStatusParams, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkedInAccountInfoResponse, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type ListApprovalsOptions, type ListExecutionsOptions, type ListProvidersResponse, 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, OutreachMethod, type PaginationInfo, type PaginationParams, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, 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, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RejectStepRequest, type ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type 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 SkipStepRequest, type SkipStepResponse, type SkippedProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getInmailAllowance, getLimits, getMessageLimit, hasOpenProfileMessages, verifyWebhookSignature };
|
|
4533
|
+
export { ACTION_DELAYS, type ActionLimit, type AddAndRunCriterionRequest, type AddCriterionRequest, type AgentConfig, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalItem, type ApprovalListResponse, type ApprovalResponse, 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 CancelDraftResponse, type CancelResponseResponse, type ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type 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 CriterionType, DAILY_INMAIL_LIMITS, type DatabaseStatus, type DeleteApiKeyResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type Email, type EmailAction, type EmailThreadSummary, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, 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 GetConnectionStatusParams, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkedInAccountInfoResponse, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type ListApprovalsOptions, type ListExecutionsOptions, type ListProvidersResponse, 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, OutreachMethod, type PaginationInfo, type PaginationParams, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, 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, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RejectStepRequest, type ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type 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 SkipStepRequest, type SkipStepResponse, type SkippedProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getInmailAllowance, getLimits, getMessageLimit, hasOpenProfileMessages, isRecruiterSubscription, verifyWebhookSignature };
|
package/dist/index.d.ts
CHANGED
|
@@ -85,6 +85,21 @@ declare const ACTION_DELAYS: {
|
|
|
85
85
|
readonly betweenProfileViews: 5;
|
|
86
86
|
readonly afterError: 60;
|
|
87
87
|
};
|
|
88
|
+
/**
|
|
89
|
+
* Daily InMail sending limits by subscription type.
|
|
90
|
+
*
|
|
91
|
+
* These are the maximum InMails you can SEND per day (rate limit), separate from
|
|
92
|
+
* the monthly credits you have available.
|
|
93
|
+
*
|
|
94
|
+
* Per LinkedIn official documentation (https://www.linkedin.com/help/recruiter/answer/a745199):
|
|
95
|
+
* - Recruiter Corporate/RPS: 1,000 InMails per day per seat
|
|
96
|
+
* - Recruiter Lite: Limited by monthly credits (30/month + 100 Open Profile/month)
|
|
97
|
+
* - Other tiers: No official daily limit, but limited by monthly credits
|
|
98
|
+
*
|
|
99
|
+
* For non-Recruiter accounts, we set daily limit = monthly credits to allow
|
|
100
|
+
* flexibility while still respecting credit availability.
|
|
101
|
+
*/
|
|
102
|
+
declare const DAILY_INMAIL_LIMITS: Record<LinkedInLimitSubscriptionType, number>;
|
|
88
103
|
/**
|
|
89
104
|
* Get all limits for a subscription type
|
|
90
105
|
*/
|
|
@@ -121,6 +136,27 @@ declare function hasOpenProfileMessages(subscriptionType: LinkedInLimitSubscript
|
|
|
121
136
|
* - Other actions: recruiter_corporate > sales_navigator > recruiter_lite > premium_business > premium_career > basic
|
|
122
137
|
*/
|
|
123
138
|
declare function getBestSubscriptionForAction(subscriptionTypes: (LinkedInLimitSubscriptionType | string)[], action: 'inmail' | 'connection_requests' | 'messages'): LinkedInLimitSubscriptionType | string | null;
|
|
139
|
+
/**
|
|
140
|
+
* Get daily InMail sending limit for a subscription type.
|
|
141
|
+
*
|
|
142
|
+
* Per LinkedIn official documentation:
|
|
143
|
+
* - Recruiter Corporate: 1,000 InMails per day per seat
|
|
144
|
+
* - Recruiter Lite: ~100/day (30 regular + 100 Open Profile per month)
|
|
145
|
+
* - Other tiers: Limited by monthly credits
|
|
146
|
+
*
|
|
147
|
+
* Note: This is the daily SENDING rate limit, not the total credits available.
|
|
148
|
+
* Credits are still consumed per InMail sent.
|
|
149
|
+
*/
|
|
150
|
+
declare function getDailyInmailLimit(subscriptionType: LinkedInLimitSubscriptionType | string | null | undefined): number;
|
|
151
|
+
/**
|
|
152
|
+
* Check if subscription type is a Recruiter subscription.
|
|
153
|
+
*
|
|
154
|
+
* Recruiter subscriptions have special privileges:
|
|
155
|
+
* - High daily InMail limits (up to 1,000/day for Corporate)
|
|
156
|
+
* - Access to Recruiter API features
|
|
157
|
+
* - Open Profile messaging (free InMails to open profiles)
|
|
158
|
+
*/
|
|
159
|
+
declare function isRecruiterSubscription(subscriptionType: LinkedInLimitSubscriptionType | string | null | undefined): boolean;
|
|
124
160
|
|
|
125
161
|
interface ContentLimit {
|
|
126
162
|
channel: string;
|
|
@@ -192,7 +228,7 @@ interface TenantDetailsResponse {
|
|
|
192
228
|
updatedAt: string;
|
|
193
229
|
}
|
|
194
230
|
|
|
195
|
-
type ApiProvider = 'OPENAI_API_KEY' | 'ANTHROPIC_API_KEY' | 'EXA_API_KEY' | 'COHERE_API_KEY' | 'CORESIGNAL_API_KEY' | 'GOOGLE_API_KEY' | 'SERPAPI_API_KEY' | 'GROQ_API_KEY' | 'NVIDIA_API_KEY' | 'FIREWORKS_API_KEY' | 'MISTRAL_API_KEY' | 'TOGETHER_API_KEY' | 'XAI_API_KEY' | 'PPLX_API_KEY' | 'HUGGINGFACE_API_KEY' | 'DEEPSEEK_API_KEY' | 'IBM_API_KEY' | 'E2B_API_KEY';
|
|
231
|
+
type ApiProvider = 'OPENAI_API_KEY' | 'ANTHROPIC_API_KEY' | 'EXA_API_KEY' | 'COHERE_API_KEY' | 'CORESIGNAL_API_KEY' | 'GOOGLE_API_KEY' | 'SERPAPI_API_KEY' | 'GROQ_API_KEY' | 'NVIDIA_API_KEY' | 'FIREWORKS_API_KEY' | 'MISTRAL_API_KEY' | 'TOGETHER_API_KEY' | 'XAI_API_KEY' | 'PPLX_API_KEY' | 'HUGGINGFACE_API_KEY' | 'DEEPSEEK_API_KEY' | 'IBM_API_KEY' | 'PDL_API_KEY' | 'CRUSTDATA_API_KEY' | 'ENRICH_LAYER_API_KEY' | 'E2B_API_KEY' | 'AWS_ACCESS_KEY_ID' | 'AWS_SECRET_ACCESS_KEY';
|
|
196
232
|
interface StoreApiKeyRequest {
|
|
197
233
|
provider: ApiProvider;
|
|
198
234
|
apiKey: string;
|
|
@@ -767,6 +803,94 @@ interface SpecializedAgentParams {
|
|
|
767
803
|
* Each candidate must include at least one identifier: linkedin_url or email/emails.
|
|
768
804
|
*/
|
|
769
805
|
candidateProfiles?: Array<Record<string, any>>;
|
|
806
|
+
/**
|
|
807
|
+
* Whether to search profile databases (CrustData/PDL).
|
|
808
|
+
* Options: true (always), false (never), 'auto' (LLM decides).
|
|
809
|
+
* @default true
|
|
810
|
+
* Used by deep_people_search.
|
|
811
|
+
*/
|
|
812
|
+
searchProfiles?: boolean | 'auto';
|
|
813
|
+
/**
|
|
814
|
+
* Whether to search LinkedIn posts for engagement (authors, reactors, commenters).
|
|
815
|
+
* Options: true (always), false (never), 'auto' (LLM decides based on query).
|
|
816
|
+
* @default 'auto'
|
|
817
|
+
* Used by deep_people_search.
|
|
818
|
+
*/
|
|
819
|
+
searchPosts?: boolean | 'auto';
|
|
820
|
+
/**
|
|
821
|
+
* Whether to include LinkedIn post engagement in candidate scoring.
|
|
822
|
+
* Options: true (always), false (never), 'auto' (LLM decides).
|
|
823
|
+
* @default 'auto'
|
|
824
|
+
* Used by deep_people_search.
|
|
825
|
+
*/
|
|
826
|
+
includeEngagementInScore?: boolean | 'auto';
|
|
827
|
+
/**
|
|
828
|
+
* Maximum number of posts to search.
|
|
829
|
+
* Range: 1-500
|
|
830
|
+
* @default 50
|
|
831
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
832
|
+
*/
|
|
833
|
+
postsMaxResults?: number;
|
|
834
|
+
/**
|
|
835
|
+
* Maximum number of keywords to use for posts search.
|
|
836
|
+
* If not provided, all extracted keywords are used.
|
|
837
|
+
* Range: 1-20
|
|
838
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
839
|
+
*/
|
|
840
|
+
postsMaxKeywords?: number;
|
|
841
|
+
/**
|
|
842
|
+
* Date range for posts search.
|
|
843
|
+
* Options: 'past-24h', 'past-week', 'past-month', 'past-year'
|
|
844
|
+
* @default 'past-month'
|
|
845
|
+
* Used by deep_people_search.
|
|
846
|
+
*/
|
|
847
|
+
postsDateRange?: 'past-24h' | 'past-week' | 'past-month' | 'past-year';
|
|
848
|
+
/**
|
|
849
|
+
* Engagement fields to fetch from posts.
|
|
850
|
+
* Options: 'reactors' (5 credits/post), 'comments' (5 credits/post), 'reactors,comments' (10 credits/post)
|
|
851
|
+
* @default 'reactors'
|
|
852
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
853
|
+
*/
|
|
854
|
+
postsFields?: 'reactors' | 'comments' | 'reactors,comments';
|
|
855
|
+
/**
|
|
856
|
+
* Maximum reactors per post to fetch.
|
|
857
|
+
* Range: 1-5000
|
|
858
|
+
* @default 5000
|
|
859
|
+
* No additional cost (same 5 credits/post for 1-5000 reactors).
|
|
860
|
+
* Used by deep_people_search when postsFields includes 'reactors'.
|
|
861
|
+
*/
|
|
862
|
+
postsMaxReactors?: number;
|
|
863
|
+
/**
|
|
864
|
+
* Maximum comments per post to fetch.
|
|
865
|
+
* Range: 1-5000
|
|
866
|
+
* @default 5000
|
|
867
|
+
* No additional cost (same 5 credits/post for 1-5000 comments).
|
|
868
|
+
* Used by deep_people_search when postsFields includes 'comments'.
|
|
869
|
+
*/
|
|
870
|
+
postsMaxComments?: number;
|
|
871
|
+
/**
|
|
872
|
+
* Whether to enrich posts candidates with EnrichLayer.
|
|
873
|
+
* @default false
|
|
874
|
+
* CrustData posts API already provides rich data (skills, experience, education).
|
|
875
|
+
* Enable only if you need additional fields from EnrichLayer.
|
|
876
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
877
|
+
*/
|
|
878
|
+
postsEnableEnrichment?: boolean;
|
|
879
|
+
/**
|
|
880
|
+
* Whether to filter posts for relevance before extracting people.
|
|
881
|
+
* @default true
|
|
882
|
+
* Uses LLM to identify and skip hiring posts, spam, and irrelevant content.
|
|
883
|
+
* Improves candidate quality at cost of ~1 LLM call per post.
|
|
884
|
+
* Used by deep_people_search when searchPosts is enabled.
|
|
885
|
+
*/
|
|
886
|
+
postsEnableFiltering?: boolean;
|
|
887
|
+
/**
|
|
888
|
+
* Weight for engagement score when included in match score calculation.
|
|
889
|
+
* Range: 0.0-0.3
|
|
890
|
+
* @default 0.15
|
|
891
|
+
* Used by deep_people_search when includeEngagementInScore is true.
|
|
892
|
+
*/
|
|
893
|
+
engagementScoreWeight?: number;
|
|
770
894
|
/**
|
|
771
895
|
* Additional parameters for any specialized agent
|
|
772
896
|
* This allows flexibility for future agents without SDK updates
|
|
@@ -1939,6 +2063,12 @@ interface LinkedInAccountInfoResponse {
|
|
|
1939
2063
|
connectionRequestsSentToday?: number | null;
|
|
1940
2064
|
gmailSentToday?: number | null;
|
|
1941
2065
|
outlookSentToday?: number | null;
|
|
2066
|
+
inmailDailyLimit?: number | null;
|
|
2067
|
+
directMessageDailyLimit?: number | null;
|
|
2068
|
+
connectionRequestDailyLimit?: number | null;
|
|
2069
|
+
inmailRemainingToday?: number | null;
|
|
2070
|
+
directMessagesRemainingToday?: number | null;
|
|
2071
|
+
connectionRequestsRemainingToday?: number | null;
|
|
1942
2072
|
unipileStatus?: string | null;
|
|
1943
2073
|
}
|
|
1944
2074
|
/**
|
|
@@ -3013,6 +3143,18 @@ declare class ResponsesResource {
|
|
|
3013
3143
|
excludeProfiles?: string[];
|
|
3014
3144
|
excludePreviouslyContacted?: boolean;
|
|
3015
3145
|
excludeNames?: string[];
|
|
3146
|
+
searchProfiles?: boolean | 'auto';
|
|
3147
|
+
searchPosts?: boolean | 'auto';
|
|
3148
|
+
includeEngagementInScore?: boolean | 'auto';
|
|
3149
|
+
postsMaxResults?: number;
|
|
3150
|
+
postsMaxKeywords?: number;
|
|
3151
|
+
postsDateRange?: 'past-24h' | 'past-week' | 'past-month' | 'past-year';
|
|
3152
|
+
postsFields?: 'reactors' | 'comments' | 'reactors,comments';
|
|
3153
|
+
postsMaxReactors?: number;
|
|
3154
|
+
postsMaxComments?: number;
|
|
3155
|
+
postsEnableEnrichment?: boolean;
|
|
3156
|
+
postsEnableFiltering?: boolean;
|
|
3157
|
+
engagementScoreWeight?: number;
|
|
3016
3158
|
}): Promise<CreateResponseResponse>;
|
|
3017
3159
|
/**
|
|
3018
3160
|
* Score provided candidates against AI-generated or provided criteria
|
|
@@ -4388,4 +4530,4 @@ declare class ProgressTracker {
|
|
|
4388
4530
|
*/
|
|
4389
4531
|
declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
|
|
4390
4532
|
|
|
4391
|
-
export { ACTION_DELAYS, type ActionLimit, type AddAndRunCriterionRequest, type AddCriterionRequest, type AgentConfig, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalItem, type ApprovalListResponse, type ApprovalResponse, 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 CancelDraftResponse, type CancelResponseResponse, type ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type 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 CriterionType, type DatabaseStatus, type DeleteApiKeyResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type Email, type EmailAction, type EmailThreadSummary, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, 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 GetConnectionStatusParams, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkedInAccountInfoResponse, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type ListApprovalsOptions, type ListExecutionsOptions, type ListProvidersResponse, 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, OutreachMethod, type PaginationInfo, type PaginationParams, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, 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, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RejectStepRequest, type ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type 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 SkipStepRequest, type SkipStepResponse, type SkippedProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getInmailAllowance, getLimits, getMessageLimit, hasOpenProfileMessages, verifyWebhookSignature };
|
|
4533
|
+
export { ACTION_DELAYS, type ActionLimit, type AddAndRunCriterionRequest, type AddCriterionRequest, type AgentConfig, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type ApprovalItem, type ApprovalListResponse, type ApprovalResponse, 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 CancelDraftResponse, type CancelResponseResponse, type ChannelContactHistory, ChannelType, type CheckAppEnabledParams, type CheckLinkedInConnectionRequest, type CheckPriorContactRequest, type CheckPriorContactResponse, type ChunkingStrategy, type CompleteExecutionRequest, type CompleteExecutionResponse, type ConnectionAcceptedData, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ConnectionSummary, type 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 CriterionType, DAILY_INMAIL_LIMITS, type DatabaseStatus, type DeleteApiKeyResponse, type DeleteConversationResponse, type DeleteConversationsByProjectResponse, type DisconnectRequest, type DisconnectResponse, type DraftResponse, type DraftSendOverride, DraftStatus, type DuplicateHandling, type DuplicateTemplateRequest, type Email, type EmailAction, type EmailThreadSummary, type EngagementStatus, type EngagementStatusData, type EngagementStatusRequest, type EngagementStatusResponse, type ErrorDetail, type ErrorResponse, type ErrorResponseItem, 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 GetConnectionStatusParams, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InitiateConnectionRequest, type InitiateConnectionResponse, type InmailSubscription, IntegrationsResource, InternalServerError, LINKEDIN_LIMITS, type LifecycleOperationRequest, type LifecycleOperationResponse, type LinkedInAccountInfoResponse, type LinkedInAction, type LinkedInConnectionStatus, type LinkedInCreditsResponse, type LinkedInLimitSubscriptionType, type LinkedInLimits, type LinkedInSendRequest, type LinkedInSubscriptionInfo, LinkedInSubscriptionType, type ListApprovalsOptions, type ListExecutionsOptions, type ListProvidersResponse, 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, OutreachMethod, type PaginationInfo, type PaginationParams, type PendingApprovalExtended, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, 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, ProviderType, QueueItemStatus, type QuickPeopleSearchOutput, RATE_LIMIT_COOLDOWNS, type RateLimitData, RateLimitError, type RateLimitErrorOptions, type RateLimitInfo, type RateLimitStatusResponse, type RateLimitsParams, type RateLimitsRequestItem, type RateLimitsResponseItem, type RejectStepRequest, type ReplySentiment, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type SalaryRange, type Scope, type SelectedSkill, type SendMessageRequest, type SendMessageResponse, type SendReplyRequest, type SendResult, type SequenceAction, type SequenceApprovalNeededData, type SequenceChannel, type SequenceEventType, type SequenceExecutionCompletedData, type SequenceExecutionFailedData, type 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 SkipStepRequest, type SkipStepResponse, type SkippedProspect, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type StartExecutionRequest, type StartExecutionResponse, type StepConfig, type StepExecutionStatus, type StepHistoryEntry, type StepMetric, type StoreApiKeyRequest, type StructuredResponse, type SyncJobResponse, SyncJobStatus, type SyncProspectRequest, type SyncProspectResponse, type SyncRequest, type SyncStats, type TemplateShareConfig, type TemplateShareInfo, type TemplateShareRequest, type TemplateSharesResponse, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type TransitionCondition, type TransitionConditionOperator, type TransitionConditionType, type TransitionConfig, type TransitionEventParams, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, type UUID, type UnlinkConversationsResponse, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateDraftRequest, type UpdateLinkedInSubscriptionRequest, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, VALID_EVENT_TYPES, ValidationError, type ValidationIssue, type ValidationResponse, type WebhookEvent, type WebhookPayload, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getInmailAllowance, getLimits, getMessageLimit, hasOpenProfileMessages, isRecruiterSubscription, verifyWebhookSignature };
|
package/dist/index.mjs
CHANGED
|
@@ -218,6 +218,22 @@ const ACTION_DELAYS = {
|
|
|
218
218
|
betweenProfileViews: 5,
|
|
219
219
|
afterError: 60
|
|
220
220
|
};
|
|
221
|
+
const DAILY_INMAIL_LIMITS = {
|
|
222
|
+
basic: 0,
|
|
223
|
+
// No InMail capability
|
|
224
|
+
premium: 5,
|
|
225
|
+
// 5 credits/month - can send all in one day if desired
|
|
226
|
+
premium_career: 5,
|
|
227
|
+
// Same as premium
|
|
228
|
+
premium_business: 15,
|
|
229
|
+
// 15 credits/month
|
|
230
|
+
sales_navigator: 50,
|
|
231
|
+
// 50 credits/month
|
|
232
|
+
recruiter_lite: 100,
|
|
233
|
+
// 30 InMails + up to 100 Open Profile/month
|
|
234
|
+
recruiter_corporate: 1e3
|
|
235
|
+
// LinkedIn official: 1,000/day per seat
|
|
236
|
+
};
|
|
221
237
|
function getLimits(subscriptionType) {
|
|
222
238
|
const type = subscriptionType || "basic";
|
|
223
239
|
return LINKEDIN_LIMITS[type] || LINKEDIN_LIMITS.basic;
|
|
@@ -262,6 +278,13 @@ function getBestSubscriptionForAction(subscriptionTypes, action) {
|
|
|
262
278
|
}
|
|
263
279
|
return subscriptionTypes[0];
|
|
264
280
|
}
|
|
281
|
+
function getDailyInmailLimit(subscriptionType) {
|
|
282
|
+
const type = subscriptionType || "basic";
|
|
283
|
+
return DAILY_INMAIL_LIMITS[type] ?? DAILY_INMAIL_LIMITS.basic;
|
|
284
|
+
}
|
|
285
|
+
function isRecruiterSubscription(subscriptionType) {
|
|
286
|
+
return subscriptionType === "recruiter_lite" || subscriptionType === "recruiter_corporate";
|
|
287
|
+
}
|
|
265
288
|
|
|
266
289
|
const CONTENT_LIMITS = [
|
|
267
290
|
{ channel: "linkedin", action: "connection_request", maxCharacters: 300 },
|
|
@@ -2331,6 +2354,30 @@ class ResponsesResource {
|
|
|
2331
2354
|
params.excludePreviouslyContacted = options.excludePreviouslyContacted;
|
|
2332
2355
|
if (options.excludeNames)
|
|
2333
2356
|
params.excludeNames = options.excludeNames;
|
|
2357
|
+
if (options.searchProfiles !== void 0)
|
|
2358
|
+
params.searchProfiles = options.searchProfiles;
|
|
2359
|
+
if (options.searchPosts !== void 0)
|
|
2360
|
+
params.searchPosts = options.searchPosts;
|
|
2361
|
+
if (options.includeEngagementInScore !== void 0)
|
|
2362
|
+
params.includeEngagementInScore = options.includeEngagementInScore;
|
|
2363
|
+
if (options.postsMaxResults !== void 0)
|
|
2364
|
+
params.postsMaxResults = options.postsMaxResults;
|
|
2365
|
+
if (options.postsMaxKeywords !== void 0)
|
|
2366
|
+
params.postsMaxKeywords = options.postsMaxKeywords;
|
|
2367
|
+
if (options.postsDateRange)
|
|
2368
|
+
params.postsDateRange = options.postsDateRange;
|
|
2369
|
+
if (options.postsFields)
|
|
2370
|
+
params.postsFields = options.postsFields;
|
|
2371
|
+
if (options.postsMaxReactors !== void 0)
|
|
2372
|
+
params.postsMaxReactors = options.postsMaxReactors;
|
|
2373
|
+
if (options.postsMaxComments !== void 0)
|
|
2374
|
+
params.postsMaxComments = options.postsMaxComments;
|
|
2375
|
+
if (options.postsEnableEnrichment !== void 0)
|
|
2376
|
+
params.postsEnableEnrichment = options.postsEnableEnrichment;
|
|
2377
|
+
if (options.postsEnableFiltering !== void 0)
|
|
2378
|
+
params.postsEnableFiltering = options.postsEnableFiltering;
|
|
2379
|
+
if (options.engagementScoreWeight !== void 0)
|
|
2380
|
+
params.engagementScoreWeight = options.engagementScoreWeight;
|
|
2334
2381
|
if (Object.keys(params).length > 0)
|
|
2335
2382
|
request.specializedAgentParams = params;
|
|
2336
2383
|
}
|
|
@@ -3765,4 +3812,4 @@ function verifyWebhookSignature(payload, signature, secret) {
|
|
|
3765
3812
|
);
|
|
3766
3813
|
}
|
|
3767
3814
|
|
|
3768
|
-
export { ACTION_DELAYS, AuthenticationError, BatchJobStatus, CONTENT_LIMITS, CONTENT_LIMITS_MAP, ChannelType, ConversationStatus, DraftStatus, InternalServerError, LINKEDIN_LIMITS, LinkedInSubscriptionType, LocalFileNotSupportedError, LumnisClient, LumnisError, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingSendError, MessagingValidationError, NetworkDistance, NoDataSourcesError, NotFoundError, OutreachMethod, PeopleDataSource, ProgressTracker, ProviderType, QueueItemStatus, RATE_LIMIT_COOLDOWNS, RateLimitError, SharePermission, SourcesNotAvailableError, SyncJobStatus, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, VALID_EVENT_TYPES, ValidationError, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getInmailAllowance, getLimits, getMessageLimit, hasOpenProfileMessages, verifyWebhookSignature };
|
|
3815
|
+
export { ACTION_DELAYS, AuthenticationError, BatchJobStatus, CONTENT_LIMITS, CONTENT_LIMITS_MAP, ChannelType, ConversationStatus, DAILY_INMAIL_LIMITS, DraftStatus, InternalServerError, LINKEDIN_LIMITS, LinkedInSubscriptionType, LocalFileNotSupportedError, LumnisClient, LumnisError, MessageType, MessagingAPIError, MessagingConnectionError, MessagingNotFoundError, MessagingSendError, MessagingValidationError, NetworkDistance, NoDataSourcesError, NotFoundError, OutreachMethod, PeopleDataSource, ProgressTracker, ProviderType, QueueItemStatus, RATE_LIMIT_COOLDOWNS, RateLimitError, SharePermission, SourcesNotAvailableError, SyncJobStatus, UNIPILE_RATE_LIMIT_ERRORS, UNIPILE_SAFE_LIMITS, VALID_EVENT_TYPES, ValidationError, canSendInmail, displayProgress, formatProgressEntry, getBestSubscriptionForAction, getConnectionRequestLimit, getContentLimit, getDailyInmailLimit, getInmailAllowance, getLimits, getMessageLimit, hasOpenProfileMessages, isRecruiterSubscription, verifyWebhookSignature };
|