Add sync & poll inbox

Author: LordOfTheVillage

examples/messaging.ts

@@ -20,6 +20,11 @@ async function messagingExample(): Promise<void> {
 
     await pollConversations(linkedapi, targetPersonUrl, targetPersonUrl2);
 
+    await syncInbox(linkedapi);
+    await salesNavigatorSyncInbox(linkedapi);
+
+    await pollInbox(linkedapi);
+
   } catch (error) {
     if (error instanceof LinkedApiError) {
       console.error('🚨 Linked API Error:', error.message);
@@ -155,6 +160,68 @@ async function pollConversations(linkedapi: LinkedApi, standardPersonUrl: string
   });
 }
 
+async function syncInbox(linkedapi: LinkedApi): Promise<void> {
+  console.log('\n🔄 Enabling inbox monitoring...');
+
+  const workflow = await linkedapi.syncInbox.execute({});
+  console.log('🔄 Sync inbox workflow started:', workflow.workflowId);
+  console.log('💬 Workflow message:', workflow.message);
+
+  const syncResult = await linkedapi.syncInbox.result(workflow.workflowId);
+  if (syncResult.errors.length > 0) {
+    console.error('🚨 Errors:', JSON.stringify(syncResult.errors, null, 2));
+  } else {
+    console.log('✅ Inbox monitoring enabled successfully');
+    console.log('   📥 Whole inbox is now ready for polling');
+  }
+}
+
+async function salesNavigatorSyncInbox(linkedapi: LinkedApi): Promise<void> {
+  console.log('\n🎯 Enabling Sales Navigator inbox monitoring...');
+
+  const workflow = await linkedapi.nvSyncInbox.execute({});
+  console.log('🎯 Sales Navigator sync inbox workflow started:', workflow.workflowId);
+  console.log('💬 Workflow message:', workflow.message);
+
+  const nvSyncResult = await linkedapi.nvSyncInbox.result(workflow.workflowId);
+  if (nvSyncResult.errors.length > 0) {
+    console.error('🚨 Errors:', JSON.stringify(nvSyncResult.errors, null, 2));
+  } else {
+    console.log('✅ Sales Navigator inbox monitoring enabled successfully');
+    console.log('   📥 Whole Sales Navigator inbox is now ready for polling');
+  }
+}
+
+async function pollInbox(linkedapi: LinkedApi): Promise<void> {
+  console.log('\n📥 Polling inbox...');
+
+  const pollResponse = await linkedapi.pollInbox({
+    type: 'st',
+    since: '2025-01-01T00:00:00Z',
+  });
+
+  if (pollResponse.errors.length > 0) {
+    console.error('🚨 Errors:', JSON.stringify(pollResponse.errors, null, 2));
+    return;
+  }
+
+  const messages = pollResponse.data?.messages ?? [];
+  console.log('✅ Inbox polled successfully');
+  console.log(`📊 Found ${messages.length} messages`);
+
+  messages.slice(0, 5).forEach((message) => {
+    const senderIcon = message.sender === 'us' ? '👤' : '👋';
+    console.log(`  ${senderIcon} ${message.sender.toUpperCase()} in thread ${message.threadId}: "${message.text}"`);
+    console.log(`    🔗 Type: ${message.type === 'st' ? 'Standard' : 'Sales Navigator'} | 🕐 ${message.time}`);
+
+    // Reply straight into the thread using threadId (no personUrl needed).
+    void linkedapi.sendMessage.execute({
+      threadId: message.threadId,
+      text: 'Thanks for your message!',
+    });
+  });
+}
+
 if (require.main === module) {
   messagingExample();
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkedapi/node",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Control your LinkedIn accounts and retrieve real-time data, all through this Node.js SDK.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/core/operation.ts

@@ -17,6 +17,7 @@ export const OPERATION_NAME = {
   customWorkflow: 'customWorkflow',
   sendMessage: 'sendMessage',
   syncConversation: 'syncConversation',
+  syncInbox: 'syncInbox',
   checkConnectionStatus: 'checkConnectionStatus',
   sendConnectionRequest: 'sendConnectionRequest',
   withdrawConnectionRequest: 'withdrawConnectionRequest',
@@ -37,6 +38,7 @@ export const OPERATION_NAME = {
   retrievePerformance: 'retrievePerformance',
   nvSendMessage: 'nvSendMessage',
   nvSyncConversation: 'nvSyncConversation',
+  nvSyncInbox: 'nvSyncInbox',
   nvSearchCompanies: 'nvSearchCompanies',
   nvSearchPeople: 'nvSearchPeople',
   nvFetchCompany: 'nvFetchCompany',

src/index.ts

@@ -16,6 +16,7 @@ import {
   NvSearchPeople,
   NvSendMessage,
   NvSyncConversation,
+  NvSyncInbox,
   ReactToPost,
   RemoveConnection,
   RetrieveConnections,
@@ -28,6 +29,7 @@ import {
   SendConnectionRequest,
   SendMessage,
   SyncConversation,
+  SyncInbox,
   WithdrawConnectionRequest,
 } from './operations';
 import {
@@ -38,6 +40,8 @@ import {
   TApiUsageParams,
   TConversationPollRequest,
   TConversationPollResult,
+  TInboxPollRequest,
+  TInboxPollResult,
   TLinkedApiActionErrorType,
   TLinkedApiErrorType,
 } from './types';
@@ -92,6 +96,7 @@ class LinkedApi {
     this.customWorkflow = new CustomWorkflow(this.httpClient);
     this.sendMessage = new SendMessage(this.httpClient);
     this.syncConversation = new SyncConversation(this.httpClient);
+    this.syncInbox = new SyncInbox(this.httpClient);
     this.checkConnectionStatus = new CheckConnectionStatus(this.httpClient);
     this.sendConnectionRequest = new SendConnectionRequest(this.httpClient);
     this.withdrawConnectionRequest = new WithdrawConnectionRequest(this.httpClient);
@@ -112,6 +117,7 @@ class LinkedApi {
     this.retrievePerformance = new RetrievePerformance(this.httpClient);
     this.nvSendMessage = new NvSendMessage(this.httpClient);
     this.nvSyncConversation = new NvSyncConversation(this.httpClient);
+    this.nvSyncInbox = new NvSyncInbox(this.httpClient);
     this.nvSearchCompanies = new NvSearchCompanies(this.httpClient);
     this.nvSearchPeople = new NvSearchPeople(this.httpClient);
     this.nvFetchCompany = new NvFetchCompany(this.httpClient);
@@ -121,6 +127,7 @@ class LinkedApi {
       this.customWorkflow,
       this.sendMessage,
       this.syncConversation,
+      this.syncInbox,
       this.checkConnectionStatus,
       this.sendConnectionRequest,
       this.withdrawConnectionRequest,
@@ -141,6 +148,7 @@ class LinkedApi {
       this.retrievePerformance,
       this.nvSendMessage,
       this.nvSyncConversation,
+      this.nvSyncInbox,
       this.nvSearchCompanies,
       this.nvSearchPeople,
       this.nvFetchCompany,
@@ -242,6 +250,29 @@ class LinkedApi {
    */
   public syncConversation: SyncConversation;
 
+  /**
+   * Enable whole-inbox monitoring for standard LinkedIn messaging.
+   *
+   * This method enables monitoring of your entire standard LinkedIn inbox, preparing it for future
+   * message polling with {@link pollInbox}. Unlike {@link syncConversation}, it is not scoped to a single
+   * person: once enabled, all conversations in the inbox are monitored. This action takes no parameters
+   * and returns no data.
+   *
+   * @param params - No parameters are required
+   * @returns Promise resolving to the sync action
+   *
+   * @see {@link https://linkedapi.io/docs/working-with-conversations/ Working with Conversations Documentation}
+   *
+   * @example
+   * ```typescript
+   * const workflow = await linkedapi.syncInbox.execute({});
+   *
+   * await linkedapi.syncInbox.result(workflow.workflowId);
+   * console.log("Inbox monitoring enabled and ready for polling");
+   * ```
+   */
+  public syncInbox: SyncInbox;
+
   /**
    * Send a message to a LinkedIn user via Sales Navigator.
    *
@@ -293,6 +324,30 @@ class LinkedApi {
    */
   public nvSyncConversation: NvSyncConversation;
 
+  /**
+   * Enable whole-inbox monitoring for Sales Navigator messaging.
+   *
+   * This method enables monitoring of your entire Sales Navigator inbox, preparing it for future
+   * message polling with {@link pollInbox}. Unlike {@link nvSyncConversation}, it is not scoped to a
+   * single person: once enabled, all Sales Navigator conversations are monitored. This action takes no
+   * parameters and returns no data. It can fail with a `noSalesNavigator` error if the account does not
+   * have Sales Navigator.
+   *
+   * @param params - No parameters are required
+   * @returns Promise resolving to the sync action
+   *
+   * @see {@link https://linkedapi.io/docs/working-with-conversations/ Working with Conversations Documentation}
+   *
+   * @example
+   * ```typescript
+   * const workflow = await linkedapi.nvSyncInbox.execute({});
+   *
+   * await linkedapi.nvSyncInbox.result(workflow.workflowId);
+   * console.log("Sales Navigator inbox monitoring enabled and ready for polling");
+   * ```
+   */
+  public nvSyncInbox: NvSyncInbox;
+
   /**
    * Poll multiple conversations to retrieve message history and new messages.
    *
@@ -374,6 +429,56 @@ class LinkedApi {
     }
   }
 
+  /**
+   * Poll the monitored inbox to retrieve message history and new messages.
+   *
+   * This method reads messages from the inbox previously enabled for monitoring via {@link syncInbox}
+   * and/or {@link nvSyncInbox}, using a direct HTTP request. Unlike {@link pollConversations}, it is not
+   * scoped to specific person URLs: it returns messages across the whole monitored inbox, newest-first.
+   * You can optionally filter by `since` timestamp, messaging `type`, and `threadId`.
+   *
+   * @param request - Optional filters: `since` timestamp, `type` ("st" | "nv"), and `threadId`
+   * @returns Promise resolving to a response containing the inbox messages
+   *
+   * @see {@link https://linkedapi.io/docs/working-with-conversations/ Working with Conversations Documentation}
+   *
+   * @example
+   * ```typescript
+   * const pollResponse = await linkedapi.pollInbox({
+   *   type: "st",
+   *   since: "2025-01-01T00:00:00Z",
+   * });
+   *
+   * if (pollResponse.data) {
+   *   pollResponse.data.messages.forEach((message) => {
+   *     console.log(`${message.sender} in ${message.threadId}: ${message.text}`);
+   *   });
+   * } else {
+   *   console.error("Polling failed:", pollResponse.errors);
+   * }
+   * ```
+   */
+  public async pollInbox(
+    request: TInboxPollRequest = {},
+  ): Promise<TMappedResponse<TInboxPollResult>> {
+    const response = await this.httpClient.post<TInboxPollResult>('/inbox/poll', request);
+    if (response.success && response.result) {
+      return {
+        data: response.result,
+        errors: [],
+      };
+    }
+    return {
+      data: undefined,
+      errors: [
+        {
+          type: response.error?.type as TLinkedApiActionErrorType,
+          message: response.error?.message ?? '',
+        },
+      ],
+    };
+  }
+
   /**
    * Retrieve detailed information about a LinkedIn person profile.
    *

src/operations/index.ts

@@ -7,6 +7,8 @@ export * from './send-message';
 export * from './nv-send-message';
 export * from './sync-conversation';
 export * from './nv-sync-conversation';
+export * from './sync-inbox';
+export * from './nv-sync-inbox';
 export * from './nv-fetch-person';
 export * from './nv-search-companies';
 export * from './fetch-post';

src/operations/nv-sync-inbox.ts

@@ -0,0 +1,8 @@
+import { Operation, TOperationName } from '../core';
+import { VoidWorkflowMapper } from '../mappers';
+import { TNvSyncInboxParams } from '../types';
+
+export class NvSyncInbox extends Operation<TNvSyncInboxParams, void> {
+  public override readonly operationName: TOperationName = 'nvSyncInbox';
+  protected override readonly mapper = new VoidWorkflowMapper<TNvSyncInboxParams>('nv.syncInbox');
+}

src/operations/sync-inbox.ts

@@ -0,0 +1,8 @@
+import { Operation, TOperationName } from '../core';
+import { VoidWorkflowMapper } from '../mappers';
+import { TSyncInboxParams } from '../types';
+
+export class SyncInbox extends Operation<TSyncInboxParams, void> {
+  public override readonly operationName: TOperationName = 'syncInbox';
+  protected override readonly mapper = new VoidWorkflowMapper<TSyncInboxParams>('st.syncInbox');
+}

src/types/actions/message.ts

@@ -1,24 +1,30 @@
 import { TBaseActionParams } from '../params';
 
 export interface TSendMessageParams extends TBaseActionParams {
-  personUrl: string;
+  personUrl?: string;
   text: string;
+  threadId?: string;
 }
 
 export interface TSyncConversationParams extends TBaseActionParams {
   personUrl: string;
 }
 
+export interface TSyncInboxParams extends TBaseActionParams {}
+
 export interface TNvSendMessageParams extends TBaseActionParams {
-  personUrl: string;
+  personUrl?: string;
   text: string;
-  subject: string;
+  subject?: string;
+  threadId?: string;
 }
 
 export interface TNvSyncConversationParams extends TBaseActionParams {
   personUrl: string;
 }
 
+export interface TNvSyncInboxParams extends TBaseActionParams {}
+
 export interface TConversationPollRequest {
   personUrl: string;
   since?: string;
@@ -30,6 +36,7 @@ export interface TMessage {
   sender: TMessageSender;
   text: string;
   time: string;
+  threadId: string | null;
 }
 
 export interface TConversationPollResult {
@@ -39,6 +46,26 @@ export interface TConversationPollResult {
   messages: TMessage[];
 }
 
+export interface TInboxPollRequest {
+  since?: string;
+  type?: TConversationType;
+  threadId?: string;
+}
+
+export interface TInboxMessage {
+  id: string;
+  type: TConversationType;
+  threadId: string;
+  personUrl: string;
+  sender: TMessageSender;
+  text: string;
+  time: string;
+}
+
+export interface TInboxPollResult {
+  messages: TInboxMessage[];
+}
+
 export const CONVERSATION_TYPE = {
   st: 'st',
   nv: 'nv',

src/types/errors.ts

@@ -23,7 +23,7 @@ import { TOperationName } from '../core';
  * - jobNotFound (fetchJob)
  * - commentingNotAllowed (commentOnPost)
  * - noPostingPermission (createPost, reactToPost, commentOnPost)
- * - noSalesNavigator (nvSendMessage, nvSyncConversation, nvSearchCompanies, nvSearchPeople, nvFetchCompany, nvFetchPerson)
+ * - noSalesNavigator (nvSendMessage, nvSyncConversation, nvSyncInbox, nvSearchCompanies, nvSearchPeople, nvFetchCompany, nvFetchPerson)
  * - conversationsNotSynced (pollConversations)
  */
 export const LINKED_API_ACTION_ERROR = {