Sync period

Author: KirillSergeevich

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkedapi/node",
-  "version": "2.3.6",
+  "version": "2.3.7",
   "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/index.ts

@@ -261,20 +261,27 @@ class LinkedApi {
    * Each conversation must be synced once before you can poll it for messages. This is a time-consuming
    * process that retrieves the conversation history and prepares it for future updates.
    *
-   * @param params - Parameters including the person's URL
-   * @returns Promise resolving to the sync action
+   * Syncing lasts for a limited period: `days` (1-90, 30 by default) counted from the moment the action
+   * starts running. The action returns the resulting `syncUntil` deadline, which {@link pollConversations}
+   * also reports. Once it passes, the conversation stops being updated — polling keeps returning the
+   * messages collected so far. Call this action again on the same person to start a new period; the
+   * accumulated history is preserved.
+   *
+   * @param params - Parameters including the person's URL and, optionally, how many days to sync for
+   * @returns Promise resolving to the sync action with the `syncUntil` deadline
    *
    * @see {@link https://linkedapi.io/docs/working-with-conversations/ Working with Conversations Documentation}
    * @see {@link https://linkedapi.io/docs/action-st-sync-conversation/ st.syncConversation Action Documentation}
    *
    * @example
    * ```typescript
    * const workflow = await linkedapi.syncConversation.execute({
-   *   personUrl: "https://www.linkedin.com/in/john-doe"
+   *   personUrl: "https://www.linkedin.com/in/john-doe",
+   *   days: 14
    * });
    *
-   * await linkedapi.syncConversation.result(workflow.workflowId);
-   * console.log("Conversation synced and ready for polling");
+   * const { syncUntil } = await linkedapi.syncConversation.result(workflow.workflowId);
+   * console.log(`Conversation synced, updates continue until ${syncUntil}`);
    * ```
    */
   public syncConversation: SyncConversation;
@@ -382,20 +389,27 @@ class LinkedApi {
    * Each conversation must be synced once before you can poll it for messages. This retrieves the conversation
    * history from Sales Navigator and prepares it for future updates.
    *
-   * @param params - Parameters including the person's URL
-   * @returns Promise resolving to the sync action
+   * Syncing lasts for a limited period: `days` (1-90, 30 by default) counted from the moment the action
+   * starts running. The action returns the resulting `syncUntil` deadline, which {@link pollConversations}
+   * also reports. Once it passes, the conversation stops being updated — polling keeps returning the
+   * messages collected so far. Call this action again on the same person to start a new period; the
+   * accumulated history is preserved.
+   *
+   * @param params - Parameters including the person's URL and, optionally, how many days to sync for
+   * @returns Promise resolving to the sync action with the `syncUntil` deadline
    *
    * @see {@link https://linkedapi.io/docs/working-with-conversations/ Working with Conversations Documentation}
    * @see {@link https://linkedapi.io/docs/action-nv-sync-conversation/ nv.syncConversation Action Documentation}
    *
    * @example
    * ```typescript
    * const workflow = await linkedapi.nvSyncConversation.execute({
-   *   personUrl: "https://www.linkedin.com/in/john-doe"
+   *   personUrl: "https://www.linkedin.com/in/john-doe",
+   *   days: 14
    * });
    *
-   * await linkedapi.nvSyncConversation.result(workflow.workflowId);
-   * console.log("Sales Navigator conversation synced and ready for polling");
+   * const { syncUntil } = await linkedapi.nvSyncConversation.result(workflow.workflowId);
+   * console.log(`Sales Navigator conversation synced, updates continue until ${syncUntil}`);
    * ```
    */
   public nvSyncConversation: NvSyncConversation;

src/operations/nv-sync-conversation.ts

@@ -1,10 +1,16 @@
 import { Operation, TOperationName } from '../core';
-import { VoidWorkflowMapper } from '../mappers';
-import { TNvSyncConversationParams } from '../types';
+import { SimpleWorkflowMapper } from '../mappers';
+import { TNvSyncConversationParams, TNvSyncConversationResult } from '../types';
 
-export class NvSyncConversation extends Operation<TNvSyncConversationParams, void> {
+export class NvSyncConversation extends Operation<
+  TNvSyncConversationParams,
+  TNvSyncConversationResult
+> {
   public override readonly operationName: TOperationName = 'nvSyncConversation';
-  protected override readonly mapper = new VoidWorkflowMapper<TNvSyncConversationParams>(
-    'nv.syncConversation',
-  );
+  protected override readonly mapper = new SimpleWorkflowMapper<
+    TNvSyncConversationParams,
+    TNvSyncConversationResult
+  >({
+    actionType: 'nv.syncConversation',
+  });
 }

src/operations/sync-conversation.ts

@@ -1,10 +1,13 @@
 import { Operation, TOperationName } from '../core';
-import { VoidWorkflowMapper } from '../mappers';
-import { TSyncConversationParams } from '../types';
+import { SimpleWorkflowMapper } from '../mappers';
+import { TSyncConversationParams, TSyncConversationResult } from '../types';
 
-export class SyncConversation extends Operation<TSyncConversationParams, void> {
+export class SyncConversation extends Operation<TSyncConversationParams, TSyncConversationResult> {
   public override readonly operationName: TOperationName = 'syncConversation';
-  protected override readonly mapper = new VoidWorkflowMapper<TSyncConversationParams>(
-    'st.syncConversation',
-  );
+  protected override readonly mapper = new SimpleWorkflowMapper<
+    TSyncConversationParams,
+    TSyncConversationResult
+  >({
+    actionType: 'st.syncConversation',
+  });
 }

src/types/actions/message.ts

@@ -13,6 +13,11 @@ export interface TSendMessageManageConversation {
 
 export interface TSyncConversationParams extends TBaseActionParams {
   personUrl: string;
+  days?: number;
+}
+
+export interface TSyncConversationResult {
+  syncUntil: string;
 }
 
 export interface TSyncInboxParams extends TBaseActionParams {}
@@ -26,6 +31,11 @@ export interface TNvSendMessageParams extends TBaseActionParams {
 
 export interface TNvSyncConversationParams extends TBaseActionParams {
   personUrl: string;
+  days?: number;
+}
+
+export interface TNvSyncConversationResult {
+  syncUntil: string;
 }
 
 export interface TNvSyncInboxParams extends TBaseActionParams {}
@@ -59,6 +69,7 @@ export interface TConversationPollResult {
   since?: string;
   type: TConversationType;
   messages: TMessage[];
+  syncUntil: string;
 }
 
 export interface TInboxPollRequest {