Profile viewers

Author: KirillSergeevich

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkedapi/node",
-  "version": "2.3.8",
+  "version": "2.3.9",
   "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

@@ -25,6 +25,7 @@ export const OPERATION_NAME = {
   withdrawConnectionRequest: 'withdrawConnectionRequest',
   retrievePendingRequests: 'retrievePendingRequests',
   retrieveInvitations: 'retrieveInvitations',
+  retrieveProfileViewers: 'retrieveProfileViewers',
   acceptInvitation: 'acceptInvitation',
   ignoreInvitation: 'ignoreInvitation',
   retrieveConnections: 'retrieveConnections',

src/index.ts

@@ -30,6 +30,7 @@ import {
   RetrieveInvitations,
   RetrievePendingRequests,
   RetrievePerformance,
+  RetrieveProfileViewers,
   RetrieveSSI,
   SearchCompanies,
   SearchJobs,
@@ -115,6 +116,7 @@ class LinkedApi {
     this.withdrawConnectionRequest = new WithdrawConnectionRequest(this.httpClient);
     this.retrievePendingRequests = new RetrievePendingRequests(this.httpClient);
     this.retrieveInvitations = new RetrieveInvitations(this.httpClient);
+    this.retrieveProfileViewers = new RetrieveProfileViewers(this.httpClient);
     this.acceptInvitation = new AcceptInvitation(this.httpClient);
     this.ignoreInvitation = new IgnoreInvitation(this.httpClient);
     this.retrieveConnections = new RetrieveConnections(this.httpClient);
@@ -155,6 +157,7 @@ class LinkedApi {
       this.withdrawConnectionRequest,
       this.retrievePendingRequests,
       this.retrieveInvitations,
+      this.retrieveProfileViewers,
       this.acceptInvitation,
       this.ignoreInvitation,
       this.retrieveConnections,
@@ -1173,6 +1176,27 @@ class LinkedApi {
    */
   public retrieveInvitations: RetrieveInvitations;
 
+  /**
+   * Retrieve the viewers visible on the current account's LinkedIn profile analytics page.
+   *
+   * @param params - Optional maximum number of viewers to retrieve (1-300, default 20)
+   * @returns Promise resolving to identified and anonymous profile viewers
+   *
+   * @see {@link https://linkedapi.io/sdks/retrieve-profile-viewers/ SDK Documentation}
+   * @see {@link https://linkedapi.io/docs/action-st-retrieve-profile-viewers/ st.retrieveProfileViewers Action Documentation}
+   *
+   * @example
+   * ```typescript
+   * const workflow = await linkedapi.retrieveProfileViewers.execute({ limit: 50 });
+   * const result = await linkedapi.retrieveProfileViewers.result(workflow.workflowId);
+   *
+   * for (const viewer of result.data ?? []) {
+   *   console.log(viewer.viewerType, viewer.viewedAgo);
+   * }
+   * ```
+   */
+  public readonly retrieveProfileViewers: RetrieveProfileViewers;
+
   /**
    * Accept an incoming connection, company-follow, or newsletter-subscription invitation.
    *

src/operations/index.ts

@@ -24,6 +24,7 @@ export * from './check-connection-status';
 export * from './withdraw-connection-request';
 export * from './retrieve-pending-requests';
 export * from './retrieve-invitations';
+export * from './retrieve-profile-viewers';
 export * from './accept-invitation';
 export * from './ignore-invitation';
 export * from './retrieve-connections';

src/operations/retrieve-profile-viewers.ts

@@ -0,0 +1,14 @@
+import { Operation, TOperationName } from '../core';
+import { ArrayWorkflowMapper } from '../mappers/array-workflow-mapper';
+import { TProfileViewer, TRetrieveProfileViewersParams } from '../types';
+
+export class RetrieveProfileViewers extends Operation<
+  TRetrieveProfileViewersParams,
+  Array<TProfileViewer>
+> {
+  public override readonly operationName: TOperationName = 'retrieveProfileViewers';
+  protected override readonly mapper = new ArrayWorkflowMapper<
+    TRetrieveProfileViewersParams,
+    TProfileViewer
+  >('st.retrieveProfileViewers');
+}

src/types/actions/index.ts

@@ -11,8 +11,10 @@ export * from './message';
 export * from './network';
 export * from './person';
 export * from './post';
+export * from './profile-viewer.type';
 export * from './retrieve-feed-params.type';
 export * from './retrieve-invitations-result.type';
+export * from './retrieve-profile-viewers-params.type';
 export * from './search-companies';
 export * from './search-people';
 export * from './statistics';

src/types/actions/profile-viewer.type.ts

@@ -0,0 +1,22 @@
+interface TProfileViewerBase {
+  viewedAt: string | null;
+  viewedAgo: string | null;
+}
+
+interface TIdentifiedProfileViewer extends TProfileViewerBase {
+  viewerType: 'identified';
+  name: string;
+  publicUrl: string;
+  urn: string | null;
+  headline: string | null;
+  connectionDegree: 1 | 2 | 3 | null;
+  avatarUrl: string | null;
+}
+
+interface TAnonymousProfileViewer extends TProfileViewerBase {
+  viewerType: 'anonymous';
+  description: string;
+  searchUrl: string;
+}
+
+export type TProfileViewer = TIdentifiedProfileViewer | TAnonymousProfileViewer;

src/types/actions/retrieve-profile-viewers-params.type.ts

@@ -0,0 +1,5 @@
+import type { TLimitParams } from '../params';
+
+export interface TRetrieveProfileViewersParams extends TLimitParams {
+  since?: string;
+}