linkedapi 1.3.4__tar.gz → 1.3.6__tar.gz

{linkedapi-1.3.4 → linkedapi-1.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linkedapi
-Version: 1.3.4
+Version: 1.3.6
 Summary: Official synchronous Python SDK for Linked API.
 Project-URL: Homepage, https://linkedapi.io
 Project-URL: Repository, https://github.com/Linked-API/linkedapi-python

{linkedapi-1.3.4 → linkedapi-1.3.6}/linkedapi/__init__.py

@@ -54,8 +54,10 @@ from linkedapi.operations import (
     NvSendMessage,
     NvSyncConversation,
     NvSyncInbox,
+    ReactToComment,
     ReactToPost,
     RemoveConnection,
+    ReplyToComment,
     RetrieveConnections,
     RetrieveFeed,
     RetrieveInvitations,
@@ -76,7 +78,7 @@ from linkedapi.types import *  # noqa: F403
 from linkedapi.types import __all__ as _types_all
 from linkedapi.webhooks import parse_webhook_event
 
-__version__ = "1.3.4"
+__version__ = "1.3.6"
 PredefinedOperation = Operation
 
 __all__ = [
@@ -128,8 +130,10 @@ __all__ = [
     "NvSyncInbox",
     "Operation",
     "PredefinedOperation",
+    "ReactToComment",
     "ReactToPost",
     "RemoveConnection",
+    "ReplyToComment",
     "ResponseMapping",
     "RetrieveInvitations",
     "RetrieveConnections",

{linkedapi-1.3.4 → linkedapi-1.3.6}/linkedapi/client.py

@@ -27,8 +27,10 @@ from linkedapi.operations import (
     NvSendMessage,
     NvSyncConversation,
     NvSyncInbox,
+    ReactToComment,
     ReactToPost,
     RemoveConnection,
+    ReplyToComment,
     RetrieveConnections,
     RetrieveFeed,
     RetrieveInvitations,
@@ -90,6 +92,8 @@ class LinkedApi:
         self.fetch_job = FetchJob(self.http_client)
         self.react_to_post = ReactToPost(self.http_client)
         self.comment_on_post = CommentOnPost(self.http_client)
+        self.react_to_comment = ReactToComment(self.http_client)
+        self.reply_to_comment = ReplyToComment(self.http_client)
         self.create_post = CreatePost(self.http_client)
         self.retrieve_feed = RetrieveFeed(self.http_client)
         self.retrieve_ssi = RetrieveSSI(self.http_client)
@@ -128,6 +132,8 @@ class LinkedApi:
             self.fetch_job,
             self.react_to_post,
             self.comment_on_post,
+            self.react_to_comment,
+            self.reply_to_comment,
             self.create_post,
             self.retrieve_feed,
             self.retrieve_ssi,

{linkedapi-1.3.4 → linkedapi-1.3.6}/linkedapi/core/operation.py

@@ -60,6 +60,7 @@ class Operation(ABC, Generic[TParams, TResult]):
                 workflow_id=workflow_id,
                 workflow_status=workflow_result.workflow_status,
                 message=workflow_result.message,
+                pending_reason=workflow_result.pending_reason,
             )
 
         completion = self._get_completion(workflow_result)

{linkedapi-1.3.4 → linkedapi-1.3.6}/linkedapi/errors.py

@@ -20,6 +20,8 @@ LinkedApiActionErrorType = Literal[
     "postNotFound",
     "jobNotFound",
     "commentingNotAllowed",
+    "commentNotFound",
+    "replyingNotAllowed",
     "noPostingPermission",
     "noSalesNavigator",
     "conversationsNotSynced",
@@ -43,6 +45,8 @@ LINKED_API_ACTION_ERROR_TYPES: tuple[str, ...] = (
     "postNotFound",
     "jobNotFound",
     "commentingNotAllowed",
+    "commentNotFound",
+    "replyingNotAllowed",
     "noPostingPermission",
     "noSalesNavigator",
     "conversationsNotSynced",
@@ -62,6 +66,8 @@ LinkedApiErrorType = Literal[
     "linkedinAccountSignedOut",
     "languageNotSupported",
     "workflowTimeout",
+    "outsideWorkingHours",
+    "workingHoursWaitExpired",
     "httpError",
     "tooManyRequests",
     "accountNotFound",
@@ -83,6 +89,8 @@ LINKED_API_ERROR_TYPES: tuple[str, ...] = (
     "linkedinAccountSignedOut",
     "languageNotSupported",
     "workflowTimeout",
+    "outsideWorkingHours",
+    "workingHoursWaitExpired",
     "httpError",
     "tooManyRequests",
     "accountNotFound",

{linkedapi-1.3.4 → linkedapi-1.3.6}/linkedapi/operations/__init__.py

@@ -17,8 +17,10 @@ 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_comment import ReactToComment
 from linkedapi.operations.react_to_post import ReactToPost
 from linkedapi.operations.remove_connection import RemoveConnection
+from linkedapi.operations.reply_to_comment import ReplyToComment
 from linkedapi.operations.retrieve_connections import RetrieveConnections
 from linkedapi.operations.retrieve_feed import RetrieveFeed
 from linkedapi.operations.retrieve_invitations import RetrieveInvitations
@@ -61,8 +63,10 @@ __all__ = [
     "NvSendMessage",
     "NvSyncConversation",
     "NvSyncInbox",
+    "ReactToComment",
     "ReactToPost",
     "RemoveConnection",
+    "ReplyToComment",
     "RetrieveConnections",
     "RetrieveFeed",
     "RetrieveInvitations",

linkedapi-1.3.6/linkedapi/operations/comment_on_post.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import SimpleWorkflowMapper
+from linkedapi.types import CommentOnPostParams, CommentResult
+
+
+class CommentOnPost(Operation[CommentOnPostParams, CommentResult]):
+    """Comment on a LinkedIn post."""
+
+    operation_name = "commentOnPost"
+    mapper = SimpleWorkflowMapper[CommentOnPostParams, CommentResult](
+        "st.commentOnPost",
+        result_model=CommentResult,
+    )

linkedapi-1.3.6/linkedapi/operations/react_to_comment.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import VoidWorkflowMapper
+from linkedapi.types import ReactToCommentParams
+
+
+class ReactToComment(Operation[ReactToCommentParams, None]):
+    """React to a LinkedIn comment."""
+
+    operation_name = "reactToComment"
+    mapper = VoidWorkflowMapper[ReactToCommentParams]("st.reactToComment")

linkedapi-1.3.6/linkedapi/operations/reply_to_comment.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import SimpleWorkflowMapper
+from linkedapi.types import CommentResult, ReplyToCommentParams
+
+
+class ReplyToComment(Operation[ReplyToCommentParams, CommentResult]):
+    """Reply to a LinkedIn comment."""
+
+    operation_name = "replyToComment"
+    mapper = SimpleWorkflowMapper[ReplyToCommentParams, CommentResult](
+        "st.replyToComment",
+        result_model=CommentResult,
+    )

{linkedapi-1.3.4 → linkedapi-1.3.6}/linkedapi/types/__init__.py

@@ -149,6 +149,8 @@ from linkedapi.types.post import (
     BaseFetchPostParamsWide,
     Comment,
     CommentOnPostParams,
+    CommentOnPostResult,
+    CommentResult,
     CreatePostAttachment,
     CreatePostParams,
     CreatePostResult,
@@ -168,7 +170,10 @@ from linkedapi.types.post import (
     PostType,
     Reaction,
     ReactionType,
+    ReactToCommentParams,
     ReactToPostParams,
+    ReplyToCommentParams,
+    ReplyToCommentResult,
 )
 from linkedapi.types.responses import LinkedApiRequestError, LinkedApiResponse
 from linkedapi.types.search_companies import (
@@ -230,6 +235,7 @@ from linkedapi.types.workflow import (
     WorkflowFailure,
     WorkflowInProgressResponse,
     WorkflowInProgressStatus,
+    WorkflowPendingReason,
     WorkflowResponse,
     WorkflowStartedResponse,
     WorkflowStatus,
@@ -262,6 +268,8 @@ __all__ = [
     "CheckConnectionStatusResult",
     "Comment",
     "CommentOnPostParams",
+    "CommentOnPostResult",
+    "CommentResult",
     "Company",
     "ConnectionPerson",
     "ConnectionSession",
@@ -372,6 +380,7 @@ __all__ = [
     "PostReactionsRetrievalConfig",
     "PostReposter",
     "PostType",
+    "ReactToCommentParams",
     "ReactToPostParams",
     "Reaction",
     "ReactionType",
@@ -381,6 +390,8 @@ __all__ = [
     "ReparseAccountInfoParams",
     "ReparseAccountInfoResult",
     "ReplayWebhookDeliveryParams",
+    "ReplyToCommentParams",
+    "ReplyToCommentResult",
     "ResetLimitsParams",
     "RetrieveConnectionsFilter",
     "RetrieveConnectionsParams",
@@ -438,6 +449,7 @@ __all__ = [
     "WorkflowFailure",
     "WorkflowInProgressResponse",
     "WorkflowInProgressStatus",
+    "WorkflowPendingReason",
     "WorkflowResponse",
     "WorkflowStartedResponse",
     "WorkflowStatus",

{linkedapi-1.3.4 → linkedapi-1.3.6}/linkedapi/types/post.py

@@ -40,7 +40,30 @@ class CommentOnPostParams(BaseActionParams):
     company_url: str | None = None
 
 
+class CommentResult(LinkedApiModel):
+    comment_urn: str | None = None
+    comment_url: str | None = None
+
+
+CommentOnPostResult: TypeAlias = CommentResult
+
+
+class ReactToCommentParams(BaseActionParams):
+    comment_url: str
+    type: ReactionType = "like"
+
+
+class ReplyToCommentParams(BaseActionParams):
+    comment_url: str
+    text: str
+
+
+ReplyToCommentResult: TypeAlias = CommentResult
+
+
 class PostComment(LinkedApiModel):
+    comment_urn: str | None = None
+    comment_url: str | None = None
     commenter_url: str | None = None
     commenter_name: str | None = None
     commenter_headline: str | None = None

{linkedapi-1.3.4 → linkedapi-1.3.6}/linkedapi/types/workflow.py

@@ -9,6 +9,7 @@ WorkflowPendingStatus = Literal["pending"]
 WorkflowRunningStatus = Literal["running"]
 WorkflowInProgressStatus = Literal["pending", "running"]
 WorkflowStatus = Literal["pending", "running", "completed", "failed"]
+WorkflowPendingReason = Literal["queued", "outsideWorkingHours"]
 WorkflowDefinition = dict[str, Any] | list[dict[str, Any]]
 WorkflowCompletion = dict[str, Any] | list[dict[str, Any]]
 
@@ -22,12 +23,15 @@ class WorkflowStartedResponse(LinkedApiModel):
     workflow_id: str
     workflow_status: WorkflowInProgressStatus
     message: str | None = None
+    # Optional so an older API that does not send it still parses.
+    pending_reason: WorkflowPendingReason | None = None
 
 
 class WorkflowInProgressResponse(LinkedApiModel):
     workflow_id: str
     workflow_status: WorkflowInProgressStatus
     message: str | None = None
+    pending_reason: WorkflowPendingReason | None = None
 
 
 class WorkflowFailure(LinkedApiModel):
@@ -43,6 +47,7 @@ class WorkflowResponse(LinkedApiModel):
     workflow_id: str
     workflow_status: WorkflowStatus
     message: str | None = None
+    pending_reason: WorkflowPendingReason | None = None
     completion: WorkflowCompletion | None = None
     failure: WorkflowFailure | None = None
 

{linkedapi-1.3.4 → linkedapi-1.3.6}/pyproject.toml

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

{linkedapi-1.3.4 → linkedapi-1.3.6}/tests/test_errors.py

@@ -21,6 +21,8 @@ def test_error_type_sets_match_node_contract() -> None:
         "linkedinAccountSignedOut",
         "languageNotSupported",
         "workflowTimeout",
+        "outsideWorkingHours",
+        "workingHoursWaitExpired",
         "httpError",
         "tooManyRequests",
         "accountNotFound",
@@ -47,6 +49,8 @@ def test_error_type_sets_match_node_contract() -> None:
         "postNotFound",
         "jobNotFound",
         "commentingNotAllowed",
+        "commentNotFound",
+        "replyingNotAllowed",
         "noPostingPermission",
         "noSalesNavigator",
         "conversationsNotSynced",

{linkedapi-1.3.4 → linkedapi-1.3.6}/tests/test_operations.py

@@ -13,6 +13,7 @@ from linkedapi import (
     LinkedApi,
     LinkedApiConfig,
     RetrieveFeedParams,
+    SimpleWorkflowMapper,
     VoidWorkflowMapper,
 )
 
@@ -53,6 +54,8 @@ def test_linked_api_exposes_all_predefined_operations() -> None:
         "nv_manage_conversation",
         "react_to_post",
         "comment_on_post",
+        "react_to_comment",
+        "reply_to_comment",
         "create_post",
         "retrieve_ssi",
         "retrieve_performance",
@@ -63,7 +66,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) == 36
+    assert len(linkedapi.operations) == 38
 
 
 def test_operation_mappers_match_node_contract() -> None:
@@ -95,6 +98,12 @@ def test_operation_mappers_match_node_contract() -> None:
     assert linkedapi.manage_conversation.mapper.action_type == "st.manageConversation"
     assert isinstance(linkedapi.nv_manage_conversation.mapper, VoidWorkflowMapper)
     assert linkedapi.nv_manage_conversation.mapper.action_type == "nv.manageConversation"
+    assert isinstance(linkedapi.react_to_comment.mapper, VoidWorkflowMapper)
+    assert linkedapi.react_to_comment.mapper.action_type == "st.reactToComment"
+    assert isinstance(linkedapi.comment_on_post.mapper, SimpleWorkflowMapper)
+    assert linkedapi.comment_on_post.mapper.action_type == "st.commentOnPost"
+    assert isinstance(linkedapi.reply_to_comment.mapper, SimpleWorkflowMapper)
+    assert linkedapi.reply_to_comment.mapper.action_type == "st.replyToComment"
 
 
 def test_retrieve_feed_maps_params_and_feed_context() -> None:

linkedapi-1.3.6/tests/test_working_hours_contract.py

@@ -0,0 +1,108 @@
+from __future__ import annotations
+
+from typing import Any
+from unittest.mock import Mock
+
+import pytest
+
+from linkedapi.core.operation import Operation
+from linkedapi.errors import LINKED_API_ERROR_TYPES
+from linkedapi.types import (
+    WorkflowInProgressResponse,
+    WorkflowResponse,
+    WorkflowStartedResponse,
+)
+
+
+class _StubMapper:
+    def map_request(self, params: Any) -> Any:
+        return params
+
+    def map_response(self, completion: Any) -> Any:
+        return completion
+
+
+class _StubOperation(Operation):  # type: ignore[type-arg]
+    operation_name = "fetchPerson"
+
+    def __init__(self, http_client: Any) -> None:
+        super().__init__(http_client)
+        self.mapper = _StubMapper()  # type: ignore[assignment]
+
+
+def _operation(workflow_result: dict[str, Any]) -> _StubOperation:
+    http_client = Mock()
+    http_client.get.return_value = Mock(
+        error=None,
+        result=WorkflowResponse.model_validate(workflow_result),
+    )
+    return _StubOperation(http_client)
+
+
+class TestPendingReasonModels:
+    def test_in_progress_response_accepts_a_pending_reason(self) -> None:
+        response = WorkflowInProgressResponse(
+            workflowId="wf-1",
+            workflowStatus="pending",
+            pendingReason="outsideWorkingHours",
+        )
+
+        assert response.pending_reason == "outsideWorkingHours"
+
+    def test_started_response_accepts_a_pending_reason(self) -> None:
+        response = WorkflowStartedResponse(
+            workflowId="wf-1",
+            workflowStatus="pending",
+            pendingReason="queued",
+        )
+
+        assert response.pending_reason == "queued"
+
+    @pytest.mark.parametrize(
+        "model",
+        [WorkflowInProgressResponse, WorkflowStartedResponse, WorkflowResponse],
+    )
+    def test_field_is_optional_for_back_compat(self, model: Any) -> None:
+        response = model(workflowId="wf-1", workflowStatus="running")
+
+        assert response.pending_reason is None
+
+
+class TestStatusCarriesPendingReason:
+    def test_carries_the_outside_working_hours_reason(self) -> None:
+        operation = _operation(
+            {
+                "workflowId": "wf-1",
+                "workflowStatus": "pending",
+                "pendingReason": "outsideWorkingHours",
+            }
+        )
+
+        result = operation.status("wf-1")
+
+        assert isinstance(result, WorkflowInProgressResponse)
+        assert result.pending_reason == "outsideWorkingHours"
+
+    def test_carries_the_queued_reason(self) -> None:
+        operation = _operation(
+            {"workflowId": "wf-1", "workflowStatus": "pending", "pendingReason": "queued"}
+        )
+
+        result = operation.status("wf-1")
+
+        assert isinstance(result, WorkflowInProgressResponse)
+        assert result.pending_reason == "queued"
+
+    def test_keeps_none_when_the_api_sends_nothing(self) -> None:
+        operation = _operation({"workflowId": "wf-1", "workflowStatus": "running"})
+
+        result = operation.status("wf-1")
+
+        assert isinstance(result, WorkflowInProgressResponse)
+        assert result.pending_reason is None
+
+
+class TestWorkingHoursErrorTypes:
+    @pytest.mark.parametrize("error_type", ["outsideWorkingHours", "workingHoursWaitExpired"])
+    def test_error_type_is_known(self, error_type: str) -> None:
+        assert error_type in LINKED_API_ERROR_TYPES

linkedapi-1.3.4/linkedapi/operations/comment_on_post.py

@@ -1,12 +0,0 @@
-from __future__ import annotations
-
-from linkedapi.core import Operation
-from linkedapi.mappers import VoidWorkflowMapper
-from linkedapi.types import CommentOnPostParams
-
-
-class CommentOnPost(Operation[CommentOnPostParams, None]):
-    """Comment on a LinkedIn post."""
-
-    operation_name = "commentOnPost"
-    mapper = VoidWorkflowMapper[CommentOnPostParams]("st.commentOnPost")