Add manage conversation actions for

Author: LordOfTheVillage

src/core/operation.ts

@@ -18,6 +18,7 @@ export const OPERATION_NAME = {
   sendMessage: 'sendMessage',
   syncConversation: 'syncConversation',
   syncInbox: 'syncInbox',
+  manageConversation: 'manageConversation',
   checkConnectionStatus: 'checkConnectionStatus',
   sendConnectionRequest: 'sendConnectionRequest',
   withdrawConnectionRequest: 'withdrawConnectionRequest',
@@ -39,6 +40,7 @@ export const OPERATION_NAME = {
   nvSendMessage: 'nvSendMessage',
   nvSyncConversation: 'nvSyncConversation',
   nvSyncInbox: 'nvSyncInbox',
+  nvManageConversation: 'nvManageConversation',
   nvSearchCompanies: 'nvSearchCompanies',
   nvSearchPeople: 'nvSearchPeople',
   nvFetchCompany: 'nvFetchCompany',

src/index.ts

@@ -10,8 +10,10 @@ import {
   FetchJob,
   FetchPerson,
   FetchPost,
+  ManageConversation,
   NvFetchCompany,
   NvFetchPerson,
+  NvManageConversation,
   NvSearchCompanies,
   NvSearchPeople,
   NvSendMessage,
@@ -97,6 +99,7 @@ class LinkedApi {
     this.sendMessage = new SendMessage(this.httpClient);
     this.syncConversation = new SyncConversation(this.httpClient);
     this.syncInbox = new SyncInbox(this.httpClient);
+    this.manageConversation = new ManageConversation(this.httpClient);
     this.checkConnectionStatus = new CheckConnectionStatus(this.httpClient);
     this.sendConnectionRequest = new SendConnectionRequest(this.httpClient);
     this.withdrawConnectionRequest = new WithdrawConnectionRequest(this.httpClient);
@@ -118,6 +121,7 @@ class LinkedApi {
     this.nvSendMessage = new NvSendMessage(this.httpClient);
     this.nvSyncConversation = new NvSyncConversation(this.httpClient);
     this.nvSyncInbox = new NvSyncInbox(this.httpClient);
+    this.nvManageConversation = new NvManageConversation(this.httpClient);
     this.nvSearchCompanies = new NvSearchCompanies(this.httpClient);
     this.nvSearchPeople = new NvSearchPeople(this.httpClient);
     this.nvFetchCompany = new NvFetchCompany(this.httpClient);
@@ -128,6 +132,7 @@ class LinkedApi {
       this.sendMessage,
       this.syncConversation,
       this.syncInbox,
+      this.manageConversation,
       this.checkConnectionStatus,
       this.sendConnectionRequest,
       this.withdrawConnectionRequest,
@@ -149,6 +154,7 @@ class LinkedApi {
       this.nvSendMessage,
       this.nvSyncConversation,
       this.nvSyncInbox,
+      this.nvManageConversation,
       this.nvSearchCompanies,
       this.nvSearchPeople,
       this.nvFetchCompany,
@@ -273,6 +279,32 @@ class LinkedApi {
    */
   public syncInbox: SyncInbox;
 
+  /**
+   * Manage a standard LinkedIn conversation thread.
+   *
+   * This method applies a management operation to a conversation thread identified by its `threadId`
+   * (as returned by {@link pollInbox} or {@link pollConversations}, or read from an open conversation URL).
+   * Supported operations are `archive`, `unarchive`, `star`, `unstar`, `mute`, and `unmute`. This action
+   * returns no data and can fail with a `threadNotFound` error if the thread does not exist.
+   *
+   * @param params - Parameters including the thread id and the operation to apply
+   * @returns Promise resolving to the management action
+   *
+   * @see {@link https://linkedapi.io/docs/working-with-conversations/ Working with Conversations Documentation}
+   *
+   * @example
+   * ```typescript
+   * const workflow = await linkedapi.manageConversation.execute({
+   *   threadId: "2-Zjhm...",
+   *   operation: "archive"
+   * });
+   *
+   * await linkedapi.manageConversation.result(workflow.workflowId);
+   * console.log("Conversation updated successfully");
+   * ```
+   */
+  public manageConversation: ManageConversation;
+
   /**
    * Send a message to a LinkedIn user via Sales Navigator.
    *
@@ -348,6 +380,33 @@ class LinkedApi {
    */
   public nvSyncInbox: NvSyncInbox;
 
+  /**
+   * Manage a Sales Navigator conversation thread.
+   *
+   * This method applies a management operation to a Sales Navigator conversation thread identified by its
+   * `threadId` (as returned by {@link pollInbox} or {@link pollConversations}, or read from an open
+   * conversation URL). Supported operations are `archive` and `unarchive`. This action returns no data and
+   * can fail with a `noSalesNavigator` error if the account does not have Sales Navigator, or a
+   * `threadNotFound` error if the thread does not exist.
+   *
+   * @param params - Parameters including the thread id and the operation to apply
+   * @returns Promise resolving to the management action
+   *
+   * @see {@link https://linkedapi.io/docs/working-with-conversations/ Working with Conversations Documentation}
+   *
+   * @example
+   * ```typescript
+   * const workflow = await linkedapi.nvManageConversation.execute({
+   *   threadId: "2-Zjhm...",
+   *   operation: "archive"
+   * });
+   *
+   * await linkedapi.nvManageConversation.result(workflow.workflowId);
+   * console.log("Sales Navigator conversation updated successfully");
+   * ```
+   */
+  public nvManageConversation: NvManageConversation;
+
   /**
    * Poll multiple conversations to retrieve message history and new messages.
    *

src/operations/index.ts

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

src/operations/manage-conversation.ts

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

src/operations/nv-manage-conversation.ts

@@ -0,0 +1,10 @@
+import { Operation, TOperationName } from '../core';
+import { VoidWorkflowMapper } from '../mappers';
+import { TNvManageConversationParams } from '../types';
+
+export class NvManageConversation extends Operation<TNvManageConversationParams, void> {
+  public override readonly operationName: TOperationName = 'nvManageConversation';
+  protected override readonly mapper = new VoidWorkflowMapper<TNvManageConversationParams>(
+    'nv.manageConversation',
+  );
+}

src/types/actions/message.ts

@@ -25,6 +25,16 @@ export interface TNvSyncConversationParams extends TBaseActionParams {
 
 export interface TNvSyncInboxParams extends TBaseActionParams {}
 
+export interface TManageConversationParams extends TBaseActionParams {
+  threadId: string;
+  operation: TManageConversationOperation;
+}
+
+export interface TNvManageConversationParams extends TBaseActionParams {
+  threadId: string;
+  operation: TNvManageConversationOperation;
+}
+
 export interface TConversationPollRequest {
   personUrl: string;
   since?: string;
@@ -77,3 +87,21 @@ export const MESSAGE_SENDER = {
   them: 'them',
 } as const;
 export type TMessageSender = (typeof MESSAGE_SENDER)[keyof typeof MESSAGE_SENDER];
+
+export const MANAGE_CONVERSATION_OPERATION = {
+  archive: 'archive',
+  unarchive: 'unarchive',
+  star: 'star',
+  unstar: 'unstar',
+  mute: 'mute',
+  unmute: 'unmute',
+} as const;
+export type TManageConversationOperation =
+  (typeof MANAGE_CONVERSATION_OPERATION)[keyof typeof MANAGE_CONVERSATION_OPERATION];
+
+export const NV_MANAGE_CONVERSATION_OPERATION = {
+  archive: 'archive',
+  unarchive: 'unarchive',
+} as const;
+export type TNvManageConversationOperation =
+  (typeof NV_MANAGE_CONVERSATION_OPERATION)[keyof typeof NV_MANAGE_CONVERSATION_OPERATION];

src/types/errors.ts

@@ -23,8 +23,9 @@ import { TOperationName } from '../core';
  * - jobNotFound (fetchJob)
  * - commentingNotAllowed (commentOnPost)
  * - noPostingPermission (createPost, reactToPost, commentOnPost)
- * - noSalesNavigator (nvSendMessage, nvSyncConversation, nvSyncInbox, nvSearchCompanies, nvSearchPeople, nvFetchCompany, nvFetchPerson)
+ * - noSalesNavigator (nvSendMessage, nvSyncConversation, nvSyncInbox, nvSearchCompanies, nvSearchPeople, nvFetchCompany, nvFetchPerson, nvManageConversation)
  * - conversationsNotSynced (pollConversations)
+ * - threadNotFound (manageConversation, nvManageConversation)
  */
 export const LINKED_API_ACTION_ERROR = {
   personNotFound: 'personNotFound',
@@ -47,6 +48,7 @@ export const LINKED_API_ACTION_ERROR = {
   noPostingPermission: 'noPostingPermission',
   noSalesNavigator: 'noSalesNavigator',
   conversationsNotSynced: 'conversationsNotSynced',
+  threadNotFound: 'threadNotFound',
 } as const;
 export type TLinkedApiActionErrorType =
   (typeof LINKED_API_ACTION_ERROR)[keyof typeof LINKED_API_ACTION_ERROR];