Profile viewers

Author: KirillSergeevich

linkedapi/__init__.py

@@ -63,6 +63,7 @@
     RetrieveInvitations,
     RetrievePendingRequests,
     RetrievePerformance,
+    RetrieveProfileViewers,
     RetrieveSSI,
     SearchCompanies,
     SearchJobs,
@@ -78,7 +79,7 @@
 from linkedapi.types import __all__ as _types_all
 from linkedapi.webhooks import parse_webhook_event
 
-__version__ = "1.3.8"
+__version__ = "1.3.9"
 PredefinedOperation = Operation
 
 __all__ = [
@@ -140,6 +141,7 @@
     "RetrieveFeed",
     "RetrievePendingRequests",
     "RetrievePerformance",
+    "RetrieveProfileViewers",
     "RetrieveSSI",
     "SearchCompanies",
     "SearchJobs",

linkedapi/client.py

@@ -36,6 +36,7 @@
     RetrieveInvitations,
     RetrievePendingRequests,
     RetrievePerformance,
+    RetrieveProfileViewers,
     RetrieveSSI,
     SearchCompanies,
     SearchJobs,
@@ -98,6 +99,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
         self.retrieve_feed = RetrieveFeed(self.http_client)
         self.retrieve_ssi = RetrieveSSI(self.http_client)
         self.retrieve_performance = RetrievePerformance(self.http_client)
+        self.retrieve_profile_viewers = RetrieveProfileViewers(self.http_client)
         self.nv_send_message = NvSendMessage(self.http_client)
         self.nv_sync_conversation = NvSyncConversation(self.http_client)
         self.nv_sync_inbox = NvSyncInbox(self.http_client)
@@ -138,6 +140,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
             self.retrieve_feed,
             self.retrieve_ssi,
             self.retrieve_performance,
+            self.retrieve_profile_viewers,
             self.nv_send_message,
             self.nv_sync_conversation,
             self.nv_sync_inbox,

linkedapi/operations/__init__.py

@@ -26,6 +26,7 @@
 from linkedapi.operations.retrieve_invitations import RetrieveInvitations
 from linkedapi.operations.retrieve_pending_requests import RetrievePendingRequests
 from linkedapi.operations.retrieve_performance import RetrievePerformance
+from linkedapi.operations.retrieve_profile_viewers import RetrieveProfileViewers
 from linkedapi.operations.retrieve_ssi import RetrieveSSI
 from linkedapi.operations.search_companies import SearchCompanies
 from linkedapi.operations.search_jobs import SearchJobs
@@ -72,6 +73,7 @@
     "RetrieveInvitations",
     "RetrievePendingRequests",
     "RetrievePerformance",
+    "RetrieveProfileViewers",
     "RetrieveSSI",
     "SearchCompanies",
     "SearchJobs",

linkedapi/operations/retrieve_profile_viewers.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import ArrayWorkflowMapper
+from linkedapi.types import ProfileViewer, RetrieveProfileViewersParams
+
+
+class RetrieveProfileViewers(Operation[RetrieveProfileViewersParams, list[ProfileViewer]]):
+    """Retrieve the viewers visible on the current account's LinkedIn profile."""
+
+    operation_name = "retrieveProfileViewers"
+    mapper = ArrayWorkflowMapper[RetrieveProfileViewersParams, ProfileViewer](
+        "st.retrieveProfileViewers",
+        ProfileViewer,
+    )

linkedapi/types/__init__.py

@@ -177,6 +177,11 @@
     ReplyToCommentParams,
     ReplyToCommentResult,
 )
+from linkedapi.types.profile_viewers import (
+    ProfileViewer,
+    ProfileViewerType,
+    RetrieveProfileViewersParams,
+)
 from linkedapi.types.responses import LinkedApiRequestError, LinkedApiResponse
 from linkedapi.types.search_companies import (
     AnnualRevenueFilter,
@@ -383,6 +388,8 @@
     "PostReactionsRetrievalConfig",
     "PostReposter",
     "PostType",
+    "ProfileViewer",
+    "ProfileViewerType",
     "ReactToCommentParams",
     "ReactToPostParams",
     "Reaction",
@@ -402,6 +409,7 @@
     "RetrieveFeedParams",
     "RetrievePendingRequestsResult",
     "RetrievePerformanceResult",
+    "RetrieveProfileViewersParams",
     "RetrieveSSIResult",
     "SalaryPeriod",
     "SearchCompaniesFilter",

linkedapi/types/profile_viewers.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from pydantic import Field, model_validator
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams
+
+ProfileViewerType = Literal["identified", "anonymous"]
+
+
+class RetrieveProfileViewersParams(BaseActionParams):
+    limit: int | None = Field(default=None, ge=1, le=300)
+    since: str | None = None
+
+
+class ProfileViewer(LinkedApiModel):
+    viewer_type: ProfileViewerType
+    viewed_at: str | None
+    viewed_ago: str | None
+    name: str | None = None
+    public_url: str | None = None
+    urn: str | None = None
+    headline: str | None = None
+    connection_degree: Literal[1, 2, 3] | None = None
+    avatar_url: str | None = None
+    description: str | None = None
+    search_url: str | None = None
+
+    @model_validator(mode="after")
+    def validate_type_fields(self) -> ProfileViewer:
+        type_fields = {
+            "name",
+            "public_url",
+            "urn",
+            "headline",
+            "connection_degree",
+            "avatar_url",
+            "description",
+            "search_url",
+        }
+        required_fields = {
+            "identified": {
+                "name",
+                "public_url",
+                "urn",
+                "headline",
+                "connection_degree",
+                "avatar_url",
+            },
+            "anonymous": {"description", "search_url"},
+        }[self.viewer_type]
+        missing_fields = required_fields - self.model_fields_set
+        if missing_fields:
+            msg = (
+                f"{self.viewer_type} profile viewer is missing required fields: "
+                f"{', '.join(sorted(missing_fields))}"
+            )
+            raise ValueError(msg)
+
+        unexpected_fields = (self.model_fields_set & type_fields) - required_fields
+        if unexpected_fields:
+            msg = (
+                f"{self.viewer_type} profile viewer contains fields for another type: "
+                f"{', '.join(sorted(unexpected_fields))}"
+            )
+            raise ValueError(msg)
+
+        required_values = {
+            "identified": {"name": self.name, "public_url": self.public_url},
+            "anonymous": {"description": self.description, "search_url": self.search_url},
+        }[self.viewer_type]
+        null_fields = [name for name, value in required_values.items() if value is None]
+        if null_fields:
+            msg = (
+                f"{self.viewer_type} profile viewer requires non-null fields: "
+                f"{', '.join(sorted(null_fields))}"
+            )
+            raise ValueError(msg)
+
+        return self