Add network sync: sync_network, poll_network, network.* webhooks

Author: LordOfTheVillage

linkedapi/__init__.py

@@ -68,6 +68,7 @@
     SendMessage,
     SyncConversation,
     SyncInbox,
+    SyncNetwork,
     WithdrawConnectionRequest,
 )
 from linkedapi.types import *  # noqa: F403
@@ -142,6 +143,7 @@
     "SimpleWorkflowMapper",
     "SyncConversation",
     "SyncInbox",
+    "SyncNetwork",
     "ThenWorkflowMapper",
     "VoidWorkflowMapper",
     "WithdrawConnectionRequest",

linkedapi/client.py

@@ -41,6 +41,7 @@
     SendMessage,
     SyncConversation,
     SyncInbox,
+    SyncNetwork,
     WithdrawConnectionRequest,
 )
 from linkedapi.types import AccountInfo, LinkedApiActionError, serialize_value
@@ -50,6 +51,7 @@
     InboxMessage,
     InboxPollRequest,
 )
+from linkedapi.types.network import NetworkEvent, NetworkPollRequest
 from linkedapi.types.statistics import ApiUsageAction, ApiUsageParams
 
 
@@ -67,6 +69,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
         self.send_message = SendMessage(self.http_client)
         self.sync_conversation = SyncConversation(self.http_client)
         self.sync_inbox = SyncInbox(self.http_client)
+        self.sync_network = SyncNetwork(self.http_client)
         self.manage_conversation = ManageConversation(self.http_client)
         self.check_connection_status = CheckConnectionStatus(self.http_client)
         self.send_connection_request = SendConnectionRequest(self.http_client)
@@ -103,6 +106,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
             self.send_message,
             self.sync_conversation,
             self.sync_inbox,
+            self.sync_network,
             self.manage_conversation,
             self.check_connection_status,
             self.send_connection_request,
@@ -189,6 +193,30 @@ def poll_inbox(
             ],
         )
 
+    def poll_network(
+        self,
+        request: NetworkPollRequest | None = None,
+    ) -> MappedResponse[list[NetworkEvent]]:
+        """Read the monitored network connection events, newest events first."""
+
+        payload = serialize_value(request) if request is not None else {}
+        response = self.http_client.post("/network/poll", payload)
+        if response.success and response.result is not None:
+            events = response.result.get("events", [])
+            return MappedResponse(
+                data=[NetworkEvent.model_validate(item) for item in events],
+                errors=[],
+            )
+        return MappedResponse(
+            data=None,
+            errors=[
+                LinkedApiActionError(
+                    type=response.error.type if response.error else "",
+                    message=response.error.message if response.error else "",
+                ),
+            ],
+        )
+
     def get_account_info(self) -> MappedResponse[AccountInfo]:
         """Retrieve basic information about the current LinkedIn account."""
 

linkedapi/operations/__init__.py

@@ -31,6 +31,7 @@
 from linkedapi.operations.send_message import SendMessage
 from linkedapi.operations.sync_conversation import SyncConversation
 from linkedapi.operations.sync_inbox import SyncInbox
+from linkedapi.operations.sync_network import SyncNetwork
 from linkedapi.operations.withdraw_connection_request import WithdrawConnectionRequest
 
 __all__ = [
@@ -73,5 +74,6 @@
     "SendMessage",
     "SyncConversation",
     "SyncInbox",
+    "SyncNetwork",
     "WithdrawConnectionRequest",
 ]

linkedapi/operations/sync_network.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import VoidWorkflowMapper
+from linkedapi.types import SyncNetworkParams
+
+
+class SyncNetwork(Operation[SyncNetworkParams, None]):
+    """Enable whole-network monitoring for standard LinkedIn connections."""
+
+    operation_name = "syncNetwork"
+    mapper = VoidWorkflowMapper[SyncNetworkParams]("st.syncNetwork")

linkedapi/types/__init__.py

@@ -118,6 +118,12 @@
     SyncConversationParams,
     SyncInboxParams,
 )
+from linkedapi.types.network import (
+    NetworkEvent,
+    NetworkEventType,
+    NetworkPollRequest,
+    SyncNetworkParams,
+)
 from linkedapi.types.params import BaseActionParams, LimitParams, LimitSinceParams
 from linkedapi.types.person import (
     BaseFetchPersonParams,
@@ -195,6 +201,8 @@
     DeleteWebhookParams,
     MessageWebhookEvent,
     MessageWebhookEventData,
+    NetworkWebhookEvent,
+    NetworkWebhookEventData,
     ReplayWebhookDeliveryParams,
     SetWebhookParams,
     SetWebhookPayloadModeParams,
@@ -313,6 +321,11 @@
     "MessageWebhookEvent",
     "MessageWebhookEventData",
     "MinAnnualRevenue",
+    "NetworkEvent",
+    "NetworkEventType",
+    "NetworkPollRequest",
+    "NetworkWebhookEvent",
+    "NetworkWebhookEventData",
     "NvBaseFetchCompanyParams",
     "NvBaseFetchCompanyParamsWide",
     "NvCompany",
@@ -401,6 +414,7 @@
     "SubscriptionStatusValue",
     "SyncConversationParams",
     "SyncInboxParams",
+    "SyncNetworkParams",
     "WebhookDelivery",
     "WebhookDeliveryStatus",
     "WebhookEvent",

linkedapi/types/network.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams
+
+NetworkEventType = Literal[
+    "connectionAccepted",
+    "connectionAdded",
+    "connectionRequestReceived",
+]
+
+
+class SyncNetworkParams(BaseActionParams):
+    pass
+
+
+class NetworkPollRequest(LinkedApiModel):
+    since: str | None = None
+    type: NetworkEventType | None = None
+
+
+class NetworkEvent(LinkedApiModel):
+    id: str | None = None
+    type: NetworkEventType | None = None
+    person_url: str | None = None
+    detected_at: str | None = None

linkedapi/types/webhooks.py

@@ -16,6 +16,9 @@
     "account.deleted",
     "inbox.messageReceived",
     "inbox.messageSent",
+    "network.connectionAccepted",
+    "network.connectionAdded",
+    "network.connectionRequestReceived",
     "webhook.test",
 ]
 WebhookDeliveryStatus = Literal["pending", "delivering", "success", "failed"]
@@ -112,6 +115,23 @@ class MessageWebhookEvent(LinkedApiModel):
     data: MessageWebhookEventData
 
 
+class NetworkWebhookEventData(LinkedApiModel):
+    account_id: str | None = None
+    person_url: str | None = None
+    detected_at: str | None = None
+
+
+class NetworkWebhookEvent(LinkedApiModel):
+    id: str
+    type: Literal[
+        "network.connectionAccepted",
+        "network.connectionAdded",
+        "network.connectionRequestReceived",
+    ]
+    created_at: str | None = None
+    data: NetworkWebhookEventData
+
+
 class WebhookTestEventData(LinkedApiModel):
     message: str | None = None
 
@@ -124,5 +144,9 @@ class WebhookTestEvent(LinkedApiModel):
 
 
 WebhookEvent = (
-    WorkflowWebhookEvent | AccountWebhookEvent | MessageWebhookEvent | WebhookTestEvent
+    WorkflowWebhookEvent
+    | AccountWebhookEvent
+    | MessageWebhookEvent
+    | NetworkWebhookEvent
+    | WebhookTestEvent
 )

linkedapi/webhooks/parse.py

@@ -5,6 +5,7 @@
 from linkedapi.types.webhooks import (
     AccountWebhookEvent,
     MessageWebhookEvent,
+    NetworkWebhookEvent,
     WebhookEvent,
     WebhookTestEvent,
     WorkflowWebhookEvent,
@@ -44,6 +45,8 @@ def parse_webhook_event(raw_body: str | bytes) -> WebhookEvent:
         return AccountWebhookEvent.model_validate(parsed)
     if event_type.startswith("inbox."):
         return MessageWebhookEvent.model_validate(parsed)
+    if event_type.startswith("network."):
+        return NetworkWebhookEvent.model_validate(parsed)
     if event_type == "webhook.test":
         return WebhookTestEvent.model_validate(parsed)
 

pyproject.toml

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