retrieveFeed

Author: KirillSergeevich

linkedapi/__init__.py

@@ -57,6 +57,7 @@
     ReactToPost,
     RemoveConnection,
     RetrieveConnections,
+    RetrieveFeed,
     RetrieveInvitations,
     RetrievePendingRequests,
     RetrievePerformance,
@@ -75,7 +76,7 @@
 from linkedapi.types import __all__ as _types_all
 from linkedapi.webhooks import parse_webhook_event
 
-__version__ = "1.3.2"
+__version__ = "1.3.4"
 PredefinedOperation = Operation
 
 __all__ = [
@@ -132,6 +133,7 @@
     "ResponseMapping",
     "RetrieveInvitations",
     "RetrieveConnections",
+    "RetrieveFeed",
     "RetrievePendingRequests",
     "RetrievePerformance",
     "RetrieveSSI",

linkedapi/client.py

@@ -30,6 +30,7 @@
     ReactToPost,
     RemoveConnection,
     RetrieveConnections,
+    RetrieveFeed,
     RetrieveInvitations,
     RetrievePendingRequests,
     RetrievePerformance,
@@ -90,6 +91,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
         self.react_to_post = ReactToPost(self.http_client)
         self.comment_on_post = CommentOnPost(self.http_client)
         self.create_post = CreatePost(self.http_client)
+        self.retrieve_feed = RetrieveFeed(self.http_client)
         self.retrieve_ssi = RetrieveSSI(self.http_client)
         self.retrieve_performance = RetrievePerformance(self.http_client)
         self.nv_send_message = NvSendMessage(self.http_client)
@@ -127,6 +129,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
             self.react_to_post,
             self.comment_on_post,
             self.create_post,
+            self.retrieve_feed,
             self.retrieve_ssi,
             self.retrieve_performance,
             self.nv_send_message,

linkedapi/operations/__init__.py

@@ -20,6 +20,7 @@
 from linkedapi.operations.react_to_post import ReactToPost
 from linkedapi.operations.remove_connection import RemoveConnection
 from linkedapi.operations.retrieve_connections import RetrieveConnections
+from linkedapi.operations.retrieve_feed import RetrieveFeed
 from linkedapi.operations.retrieve_invitations import RetrieveInvitations
 from linkedapi.operations.retrieve_pending_requests import RetrievePendingRequests
 from linkedapi.operations.retrieve_performance import RetrievePerformance
@@ -63,6 +64,7 @@
     "ReactToPost",
     "RemoveConnection",
     "RetrieveConnections",
+    "RetrieveFeed",
     "RetrieveInvitations",
     "RetrievePendingRequests",
     "RetrievePerformance",

linkedapi/operations/retrieve_feed.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import ArrayWorkflowMapper
+from linkedapi.types import FeedPost, RetrieveFeedParams
+
+
+class RetrieveFeed(Operation[RetrieveFeedParams, list[FeedPost]]):
+    """Retrieve posts from the current account's LinkedIn home feed."""
+
+    operation_name = "retrieveFeed"
+    mapper = ArrayWorkflowMapper[RetrieveFeedParams, FeedPost](
+        "st.retrieveFeed",
+        FeedPost,
+    )

linkedapi/types/__init__.py

@@ -87,6 +87,7 @@
     SendConnectionRequestParams,
     WithdrawConnectionRequestParams,
 )
+from linkedapi.types.feed import FeedPost, RetrieveFeedParams
 from linkedapi.types.jobs import (
     FetchJobParams,
     FetchJobResult,
@@ -281,6 +282,7 @@
     "DeleteWebhookParams",
     "DisconnectParams",
     "EmploymentType",
+    "FeedPost",
     "FetchCompanyParams",
     "FetchCompanyResult",
     "FetchJobParams",
@@ -383,6 +385,7 @@
     "RetrieveConnectionsFilter",
     "RetrieveConnectionsParams",
     "RetrieveConnectionsResult",
+    "RetrieveFeedParams",
     "RetrievePendingRequestsResult",
     "RetrievePerformanceResult",
     "RetrieveSSIResult",

linkedapi/types/feed.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from pydantic import Field
+
+from linkedapi.types.params import LimitParams
+from linkedapi.types.post import Post
+
+
+class FeedPost(Post):
+    feed_context: str | None = None
+
+
+class RetrieveFeedParams(LimitParams):
+    limit: int | None = Field(default=None, ge=1, le=100)

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "linkedapi"
-version = "1.3.3"
+version = "1.3.4"
 description = "Official synchronous Python SDK for Linked API."
 readme = "README.md"
 requires-python = ">=3.10"

tests/test_operations.py

@@ -7,10 +7,12 @@
 from linkedapi import (
     AcceptInvitationParams,
     ArrayWorkflowMapper,
+    FeedPost,
     FetchPersonParams,
     Invitation,
     LinkedApi,
     LinkedApiConfig,
+    RetrieveFeedParams,
     VoidWorkflowMapper,
 )
 
@@ -38,6 +40,7 @@ def test_linked_api_exposes_all_predefined_operations() -> None:
         "retrieve_pending_requests",
         "retrieve_invitations",
         "retrieve_connections",
+        "retrieve_feed",
         "remove_connection",
         "send_message",
         "sync_conversation",
@@ -60,7 +63,7 @@ def test_linked_api_exposes_all_predefined_operations() -> None:
         assert hasattr(operation, "execute")
         assert hasattr(operation, "result")
         assert hasattr(operation, "cancel")
-    assert len(linkedapi.operations) == 35
+    assert len(linkedapi.operations) == 36
 
 
 def test_operation_mappers_match_node_contract() -> None:
@@ -82,6 +85,8 @@ def test_operation_mappers_match_node_contract() -> None:
     assert linkedapi.ignore_invitation.mapper.action_type == "st.ignoreInvitation"
     assert isinstance(linkedapi.retrieve_invitations.mapper, ArrayWorkflowMapper)
     assert linkedapi.retrieve_invitations.mapper.base_action_type == "st.retrieveInvitations"
+    assert isinstance(linkedapi.retrieve_feed.mapper, ArrayWorkflowMapper)
+    assert linkedapi.retrieve_feed.mapper.base_action_type == "st.retrieveFeed"
     assert isinstance(linkedapi.sync_inbox.mapper, VoidWorkflowMapper)
     assert linkedapi.sync_inbox.mapper.action_type == "st.syncInbox"
     assert isinstance(linkedapi.nv_sync_inbox.mapper, VoidWorkflowMapper)
@@ -92,6 +97,33 @@ def test_operation_mappers_match_node_contract() -> None:
     assert linkedapi.nv_manage_conversation.mapper.action_type == "nv.manageConversation"
 
 
+def test_retrieve_feed_maps_params_and_feed_context() -> None:
+    linkedapi = LinkedApi(LinkedApiConfig(linked_api_token="x", identification_token="y"))
+
+    request = linkedapi.retrieve_feed.mapper.map_request(RetrieveFeedParams(limit=25))
+    response = linkedapi.retrieve_feed.mapper.map_response(
+        {
+            "actionType": "st.retrieveFeed",
+            "success": True,
+            "data": [
+                {
+                    "url": "https://www.linkedin.com/feed/update/urn:li:activity:1",
+                    "feedContext": "Example Person reacted to this",
+                }
+            ],
+        }
+    )
+
+    assert request == {"actionType": "st.retrieveFeed", "limit": 25}
+    assert response.data is not None
+    assert isinstance(response.data[0], FeedPost)
+    assert response.data[0].feed_context == "Example Person reacted to this"
+
+    for invalid_limit in (0, 101):
+        with pytest.raises(ValidationError):
+            RetrieveFeedParams(limit=invalid_limit)
+
+
 def test_invitation_params_require_the_matching_target_url() -> None:
     params = AcceptInvitationParams(
         invitation_type="companyFollow",