Add sync & poll inbox

Author: LordOfTheVillage

linkedapi/__init__.py

@@ -49,6 +49,7 @@
     NvSearchPeople,
     NvSendMessage,
     NvSyncConversation,
+    NvSyncInbox,
     ReactToPost,
     RemoveConnection,
     RetrieveConnections,
@@ -61,13 +62,14 @@
     SendConnectionRequest,
     SendMessage,
     SyncConversation,
+    SyncInbox,
     WithdrawConnectionRequest,
 )
 from linkedapi.types import *  # noqa: F403
 from linkedapi.types import __all__ as _types_all
 from linkedapi.webhooks import parse_webhook_event
 
-__version__ = "1.1.0"
+__version__ = "1.1.1"
 PredefinedOperation = Operation
 
 __all__ = [
@@ -112,6 +114,7 @@
     "NvSearchPeople",
     "NvSendMessage",
     "NvSyncConversation",
+    "NvSyncInbox",
     "Operation",
     "PredefinedOperation",
     "ReactToPost",
@@ -128,6 +131,7 @@
     "SendMessage",
     "SimpleWorkflowMapper",
     "SyncConversation",
+    "SyncInbox",
     "ThenWorkflowMapper",
     "VoidWorkflowMapper",
     "WithdrawConnectionRequest",

linkedapi/client.py

@@ -22,6 +22,7 @@
     NvSearchPeople,
     NvSendMessage,
     NvSyncConversation,
+    NvSyncInbox,
     ReactToPost,
     RemoveConnection,
     RetrieveConnections,
@@ -34,10 +35,16 @@
     SendConnectionRequest,
     SendMessage,
     SyncConversation,
+    SyncInbox,
     WithdrawConnectionRequest,
 )
 from linkedapi.types import AccountInfo, LinkedApiActionError, serialize_value
-from linkedapi.types.message import ConversationPollRequest, ConversationPollResult
+from linkedapi.types.message import (
+    ConversationPollRequest,
+    ConversationPollResult,
+    InboxMessage,
+    InboxPollRequest,
+)
 from linkedapi.types.statistics import ApiUsageAction, ApiUsageParams
 
 
@@ -54,6 +61,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
         self.custom_workflow = CustomWorkflow(self.http_client)
         self.send_message = SendMessage(self.http_client)
         self.sync_conversation = SyncConversation(self.http_client)
+        self.sync_inbox = SyncInbox(self.http_client)
         self.check_connection_status = CheckConnectionStatus(self.http_client)
         self.send_connection_request = SendConnectionRequest(self.http_client)
         self.withdraw_connection_request = WithdrawConnectionRequest(self.http_client)
@@ -74,6 +82,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
         self.retrieve_performance = RetrievePerformance(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)
         self.nv_search_companies = NvSearchCompanies(self.http_client)
         self.nv_search_people = NvSearchPeople(self.http_client)
         self.nv_fetch_company = NvFetchCompany(self.http_client)
@@ -83,6 +92,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
             self.custom_workflow,
             self.send_message,
             self.sync_conversation,
+            self.sync_inbox,
             self.check_connection_status,
             self.send_connection_request,
             self.withdraw_connection_request,
@@ -103,6 +113,7 @@ def __init__(self, config: LinkedApiConfig | HttpClient[Any]) -> None:
             self.retrieve_performance,
             self.nv_send_message,
             self.nv_sync_conversation,
+            self.nv_sync_inbox,
             self.nv_search_companies,
             self.nv_search_people,
             self.nv_fetch_company,
@@ -139,6 +150,30 @@ def poll_conversations(
                 )
             raise
 
+    def poll_inbox(
+        self,
+        request: InboxPollRequest | None = None,
+    ) -> MappedResponse[list[InboxMessage]]:
+        """Read the monitored standard or Sales Navigator inbox, newest messages first."""
+
+        payload = serialize_value(request) if request is not None else {}
+        response = self.http_client.post("/inbox/poll", payload)
+        if response.success and response.result is not None:
+            messages = response.result.get("messages", [])
+            return MappedResponse(
+                data=[InboxMessage.model_validate(item) for item in messages],
+                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

@@ -12,6 +12,7 @@
 from linkedapi.operations.nv_search_people import NvSearchPeople
 from linkedapi.operations.nv_send_message import NvSendMessage
 from linkedapi.operations.nv_sync_conversation import NvSyncConversation
+from linkedapi.operations.nv_sync_inbox import NvSyncInbox
 from linkedapi.operations.react_to_post import ReactToPost
 from linkedapi.operations.remove_connection import RemoveConnection
 from linkedapi.operations.retrieve_connections import RetrieveConnections
@@ -24,6 +25,7 @@
 from linkedapi.operations.send_connection_request import SendConnectionRequest
 from linkedapi.operations.send_message import SendMessage
 from linkedapi.operations.sync_conversation import SyncConversation
+from linkedapi.operations.sync_inbox import SyncInbox
 from linkedapi.operations.withdraw_connection_request import WithdrawConnectionRequest
 
 __all__ = [
@@ -47,6 +49,7 @@
     "NvSearchPeople",
     "NvSendMessage",
     "NvSyncConversation",
+    "NvSyncInbox",
     "ReactToPost",
     "RemoveConnection",
     "RetrieveConnections",
@@ -59,5 +62,6 @@
     "SendConnectionRequest",
     "SendMessage",
     "SyncConversation",
+    "SyncInbox",
     "WithdrawConnectionRequest",
 ]

linkedapi/operations/nv_sync_inbox.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import VoidWorkflowMapper
+from linkedapi.types import NvSyncInboxParams
+
+
+class NvSyncInbox(Operation[NvSyncInboxParams, None]):
+    """Enable whole-inbox monitoring for Sales Navigator conversations."""
+
+    operation_name = "nvSyncInbox"
+    mapper = VoidWorkflowMapper[NvSyncInboxParams]("nv.syncInbox")

linkedapi/operations/sync_inbox.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import VoidWorkflowMapper
+from linkedapi.types import SyncInboxParams
+
+
+class SyncInbox(Operation[SyncInboxParams, None]):
+    """Enable whole-inbox monitoring for standard LinkedIn conversations."""
+
+    operation_name = "syncInbox"
+    mapper = VoidWorkflowMapper[SyncInboxParams]("st.syncInbox")

linkedapi/types/__init__.py

@@ -101,12 +101,16 @@
     ConversationPollRequest,
     ConversationPollResult,
     ConversationType,
+    InboxMessage,
+    InboxPollRequest,
     Message,
     MessageSender,
     NvSendMessageParams,
     NvSyncConversationParams,
+    NvSyncInboxParams,
     SendMessageParams,
     SyncConversationParams,
+    SyncInboxParams,
 )
 from linkedapi.types.params import BaseActionParams, LimitParams, LimitSinceParams
 from linkedapi.types.person import (
@@ -183,6 +187,8 @@
     AccountWebhookEventData,
     AccountWebhookStatus,
     DeleteWebhookParams,
+    MessageWebhookEvent,
+    MessageWebhookEventData,
     ReplayWebhookDeliveryParams,
     SetWebhookParams,
     SetWebhookPayloadModeParams,
@@ -269,6 +275,8 @@
     "GetConnectionSessionParams",
     "GetLimitsParams",
     "GetLimitsUsageParams",
+    "InboxMessage",
+    "InboxPollRequest",
     "Job",
     "JobCurrency",
     "JobDatePosted",
@@ -293,6 +301,8 @@
     "MaxAnnualRevenue",
     "Message",
     "MessageSender",
+    "MessageWebhookEvent",
+    "MessageWebhookEventData",
     "MinAnnualRevenue",
     "NvBaseFetchCompanyParams",
     "NvBaseFetchCompanyParamsWide",
@@ -313,6 +323,7 @@
     "NvSearchPeopleResult",
     "NvSendMessageParams",
     "NvSyncConversationParams",
+    "NvSyncInboxParams",
     "PendingConnectionSession",
     "Person",
     "PersonEducation",
@@ -377,6 +388,7 @@
     "SubscriptionStatus",
     "SubscriptionStatusValue",
     "SyncConversationParams",
+    "SyncInboxParams",
     "WebhookDelivery",
     "WebhookDeliveryStatus",
     "WebhookEvent",

linkedapi/types/message.py

@@ -10,24 +10,34 @@
 
 
 class SendMessageParams(BaseActionParams):
-    person_url: str
     text: str
+    person_url: str | None = None
+    thread_id: str | None = None
 
 
 class SyncConversationParams(BaseActionParams):
     person_url: str
 
 
+class SyncInboxParams(BaseActionParams):
+    pass
+
+
 class NvSendMessageParams(BaseActionParams):
-    person_url: str
     text: str
-    subject: str
+    person_url: str | None = None
+    subject: str | None = None
+    thread_id: str | None = None
 
 
 class NvSyncConversationParams(BaseActionParams):
     person_url: str
 
 
+class NvSyncInboxParams(BaseActionParams):
+    pass
+
+
 class ConversationPollRequest(LinkedApiModel):
     person_url: str
     type: ConversationType
@@ -39,10 +49,27 @@ class Message(LinkedApiModel):
     sender: MessageSender | None = None
     text: str | None = None
     time: str | None = None
+    thread_id: str | None = None
 
 
 class ConversationPollResult(LinkedApiModel):
     person_url: str | None = None
     type: ConversationType | None = None
     messages: list[Message] | None = None
     since: str | None = None
+
+
+class InboxPollRequest(LinkedApiModel):
+    since: str | None = None
+    type: ConversationType | None = None
+    thread_id: str | None = None
+
+
+class InboxMessage(LinkedApiModel):
+    id: str | None = None
+    type: ConversationType | None = None
+    thread_id: str | None = None
+    person_url: str | None = None
+    sender: MessageSender | None = None
+    text: str | None = None
+    time: str | None = None

linkedapi/types/webhooks.py

@@ -3,6 +3,7 @@
 from typing import Any, Literal
 
 from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.message import ConversationType, MessageSender
 
 WebhookPayloadMode = Literal["thin", "fat"]
 WebhookEventType = Literal[
@@ -13,6 +14,8 @@
     "account.reconnectionRequired",
     "account.frozen",
     "account.deleted",
+    "linkedin.messageReceived",
+    "linkedin.messageSent",
     "webhook.test",
 ]
 WebhookDeliveryStatus = Literal["pending", "delivering", "success", "failed"]
@@ -91,6 +94,24 @@ class AccountWebhookEvent(LinkedApiModel):
     data: AccountWebhookEventData
 
 
+class MessageWebhookEventData(LinkedApiModel):
+    account_id: str | None = None
+    type: ConversationType | None = None
+    thread_id: str | None = None
+    person_url: str | None = None
+    message_id: str | None = None
+    sender: MessageSender | None = None
+    text: str | None = None
+    time: str | None = None
+
+
+class MessageWebhookEvent(LinkedApiModel):
+    id: str
+    type: Literal["linkedin.messageReceived", "linkedin.messageSent"]
+    created_at: str | None = None
+    data: MessageWebhookEventData
+
+
 class WebhookTestEventData(LinkedApiModel):
     message: str | None = None
 
@@ -102,4 +123,6 @@ class WebhookTestEvent(LinkedApiModel):
     data: WebhookTestEventData
 
 
-WebhookEvent = WorkflowWebhookEvent | AccountWebhookEvent | WebhookTestEvent
+WebhookEvent = (
+    WorkflowWebhookEvent | AccountWebhookEvent | MessageWebhookEvent | WebhookTestEvent
+)

linkedapi/webhooks/parse.py

@@ -4,6 +4,7 @@
 
 from linkedapi.types.webhooks import (
     AccountWebhookEvent,
+    MessageWebhookEvent,
     WebhookEvent,
     WebhookTestEvent,
     WorkflowWebhookEvent,
@@ -41,6 +42,8 @@ def parse_webhook_event(raw_body: str | bytes) -> WebhookEvent:
         return WorkflowWebhookEvent.model_validate(parsed)
     if event_type.startswith("account."):
         return AccountWebhookEvent.model_validate(parsed)
+    if event_type.startswith("linkedin."):
+        return MessageWebhookEvent.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.1.0"
+version = "1.1.1"
 description = "Official synchronous Python SDK for Linked API."
 readme = "README.md"
 requires-python = ">=3.10"