linkedapi 1.3.10__tar.gz → 1.3.11__tar.gz

{linkedapi-1.3.10 → linkedapi-1.3.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: linkedapi
-Version: 1.3.10
+Version: 1.3.11
 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.10 → linkedapi-1.3.11}/linkedapi/__init__.py

@@ -68,6 +68,7 @@ from linkedapi.operations import (
     SearchCompanies,
     SearchJobs,
     SearchPeople,
+    SearchPosts,
     SendConnectionRequest,
     SendMessage,
     SyncConversation,
@@ -79,7 +80,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.9"
+__version__ = "1.3.11"
 PredefinedOperation = Operation
 
 __all__ = [
@@ -146,6 +147,7 @@ __all__ = [
     "SearchCompanies",
     "SearchJobs",
     "SearchPeople",
+    "SearchPosts",
     "SendConnectionRequest",
     "SendMessage",
     "SimpleWorkflowMapper",

{linkedapi-1.3.10 → linkedapi-1.3.11}/linkedapi/client.py

@@ -41,6 +41,7 @@ from linkedapi.operations import (
     SearchCompanies,
     SearchJobs,
     SearchPeople,
+    SearchPosts,
     SendConnectionRequest,
     SendMessage,
     SyncConversation,
@@ -87,6 +88,7 @@ class LinkedApi:
         self.search_companies = SearchCompanies(self.http_client)
         self.search_people = SearchPeople(self.http_client)
         self.search_jobs = SearchJobs(self.http_client)
+        self.search_posts = SearchPosts(self.http_client)
         self.fetch_company = FetchCompany(self.http_client)
         self.fetch_person = FetchPerson(self.http_client)
         self.fetch_post = FetchPost(self.http_client)
@@ -128,6 +130,7 @@ class LinkedApi:
             self.search_companies,
             self.search_people,
             self.search_jobs,
+            self.search_posts,
             self.fetch_company,
             self.fetch_person,
             self.fetch_post,

{linkedapi-1.3.10 → linkedapi-1.3.11}/linkedapi/errors.py

@@ -17,6 +17,7 @@ LinkedApiActionErrorType = Literal[
     "connectionNotFound",
     "searchingNotAllowed",
     "searchInterfaceMismatch",
+    "filterIdentityMismatch",
     "companyNotFound",
     "postNotFound",
     "jobNotFound",
@@ -43,6 +44,7 @@ LINKED_API_ACTION_ERROR_TYPES: tuple[str, ...] = (
     "connectionNotFound",
     "searchingNotAllowed",
     "searchInterfaceMismatch",
+    "filterIdentityMismatch",
     "companyNotFound",
     "postNotFound",
     "jobNotFound",

{linkedapi-1.3.10 → linkedapi-1.3.11}/linkedapi/operations/__init__.py

@@ -31,6 +31,7 @@ from linkedapi.operations.retrieve_ssi import RetrieveSSI
 from linkedapi.operations.search_companies import SearchCompanies
 from linkedapi.operations.search_jobs import SearchJobs
 from linkedapi.operations.search_people import SearchPeople
+from linkedapi.operations.search_posts import SearchPosts
 from linkedapi.operations.send_connection_request import SendConnectionRequest
 from linkedapi.operations.send_message import SendMessage
 from linkedapi.operations.sync_conversation import SyncConversation
@@ -78,6 +79,7 @@ __all__ = [
     "SearchCompanies",
     "SearchJobs",
     "SearchPeople",
+    "SearchPosts",
     "SendConnectionRequest",
     "SendMessage",
     "SyncConversation",

linkedapi-1.3.11/linkedapi/operations/search_posts.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import ArrayWorkflowMapper
+from linkedapi.types import SearchPostResult, SearchPostsParams
+
+
+class SearchPosts(Operation[SearchPostsParams, list[SearchPostResult]]):
+    """Search posts on standard LinkedIn."""
+
+    operation_name = "searchPosts"
+    mapper = ArrayWorkflowMapper[SearchPostsParams, SearchPostResult](
+        "st.searchPosts",
+        SearchPostResult,
+    )

{linkedapi-1.3.10 → linkedapi-1.3.11}/linkedapi/types/__init__.py

@@ -206,6 +206,20 @@ from linkedapi.types.search_people import (
     SearchPeopleParams,
     SearchPeopleResult,
 )
+from linkedapi.types.search_posts import (
+    PostSearchContentType,
+    PostSearchDatePosted,
+    PostSearchPostedBy,
+    PostSearchSort,
+    SearchPostActor,
+    SearchPostResult,
+    SearchPostsCompanyFilter,
+    SearchPostsCompanyFilterEntry,
+    SearchPostsFilter,
+    SearchPostsParams,
+    SearchPostsPersonFilter,
+    SearchPostsPersonFilterEntry,
+)
 from linkedapi.types.statistics import (
     ApiUsageAction,
     ApiUsageParams,
@@ -392,6 +406,10 @@ __all__ = [
     "PostReaction",
     "PostReactionsRetrievalConfig",
     "PostReposter",
+    "PostSearchContentType",
+    "PostSearchDatePosted",
+    "PostSearchPostedBy",
+    "PostSearchSort",
     "PostType",
     "ProfileViewer",
     "ProfileViewerType",
@@ -428,6 +446,14 @@ __all__ = [
     "SearchPeopleFilter",
     "SearchPeopleParams",
     "SearchPeopleResult",
+    "SearchPostActor",
+    "SearchPostResult",
+    "SearchPostsCompanyFilter",
+    "SearchPostsCompanyFilterEntry",
+    "SearchPostsFilter",
+    "SearchPostsParams",
+    "SearchPostsPersonFilter",
+    "SearchPostsPersonFilterEntry",
     "SeatType",
     "SendConnectionRequestParams",
     "SendMessageManageConversation",

linkedapi-1.3.11/linkedapi/types/search_posts.py

@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+from typing import Literal, TypeAlias
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams, LimitParams
+from linkedapi.types.post import PostActorType, PostType
+
+PostSearchSort = Literal["topMatch", "latest"]
+PostSearchDatePosted = Literal["past24Hours", "pastWeek", "pastMonth"]
+PostSearchContentType = Literal["videos", "images", "jobPosts", "liveVideos", "documents"]
+PostSearchPostedBy = Literal["me", "firstConnections", "peopleYouFollow"]
+
+
+class SearchPostsPersonFilter(LinkedApiModel):
+    """One person to narrow a post search by.
+
+    "name" is always required because LinkedIn's filter panel accepts nothing but typed text. The
+    optional identifier decides which of the offered namesakes is taken; with "name" alone the pick
+    is whichever suggestion LinkedIn ranked first.
+    """
+
+    name: str
+    urn: str | None = None
+    person_hashed_url: str | None = None
+
+
+class SearchPostsCompanyFilter(LinkedApiModel):
+    """One company to narrow a post search by. Same contract as SearchPostsPersonFilter."""
+
+    name: str
+    urn: str | None = None
+    company_hashed_url: str | None = None
+
+
+# A plain string is shorthand for the name alone: "Bill Gates" means {"name": "Bill Gates"}.
+# Both forms may be mixed in one list.
+SearchPostsPersonFilterEntry: TypeAlias = SearchPostsPersonFilter | str
+SearchPostsCompanyFilterEntry: TypeAlias = SearchPostsCompanyFilter | str
+
+
+class SearchPostsFilter(LinkedApiModel):
+    """Filtering criteria for the LinkedIn content search.
+
+    Every specified field is applied, or the action fails. Ignored entirely when
+    "custom_search_url" is specified.
+    """
+
+    sort: PostSearchSort | None = None
+    date_posted: PostSearchDatePosted | None = None
+    content_type: PostSearchContentType | None = None
+    posted_by: list[PostSearchPostedBy] | None = None
+    from_members: list[SearchPostsPersonFilterEntry] | None = None
+    from_companies: list[SearchPostsCompanyFilterEntry] | None = None
+    mentioning_members: list[SearchPostsPersonFilterEntry] | None = None
+    mentioning_companies: list[SearchPostsCompanyFilterEntry] | None = None
+    author_companies: list[SearchPostsCompanyFilterEntry] | None = None
+    author_industries: list[str] | None = None
+
+
+class SearchPostsParams(BaseActionParams, LimitParams):
+    # Either "term" or "custom_search_url" must be provided. "limit" defaults to 10 and may go up
+    # to 100, or up to 20 when child actions are attached.
+    term: str | None = None
+    filter: SearchPostsFilter | None = None
+    custom_search_url: str | None = None
+
+
+class SearchPostActor(LinkedApiModel):
+    """Whoever a search result attributes content to: its author, or the actor that reshared it.
+
+    Unlike the actors of a post returned by fetch_post, these carry no "urn": the URN is read from
+    identity anchors on the post's own page, and a search result list has none of them.
+    """
+
+    type: PostActorType | None = None
+    name: str | None = None
+    profile_url: str | None = None
+    headline: str | None = None
+    company_url: str | None = None
+
+
+class SearchPostResult(LinkedApiModel):
+    url: str | None = None
+    activity_urn: str | None = None
+    time: str | None = None
+    type: PostType | None = None
+    author: SearchPostActor | None = None
+    # Non-null only when "type" is "repost".
+    reposter: SearchPostActor | None = None
+    text: str | None = None
+    repost_text: str | None = None
+    hashtags: list[str] | None = None
+    mentions: list[str] | None = None
+    external_links: list[str] | None = None
+    images: list[str] | None = None
+    document_slides: list[str] | None = None
+    has_video: bool | None = None
+    video_thumbnail: str | None = None
+    has_poll: bool | None = None
+    reactions_count: int | None = None
+    comments_count: int | None = None
+    reposts_count: int | None = None

{linkedapi-1.3.10 → linkedapi-1.3.11}/pyproject.toml

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

{linkedapi-1.3.10 → linkedapi-1.3.11}/tests/test_errors.py

@@ -46,6 +46,7 @@ def test_error_type_sets_match_node_contract() -> None:
         "connectionNotFound",
         "searchingNotAllowed",
         "searchInterfaceMismatch",
+        "filterIdentityMismatch",
         "companyNotFound",
         "postNotFound",
         "jobNotFound",

{linkedapi-1.3.10 → linkedapi-1.3.11}/tests/test_operations.py

@@ -13,6 +13,12 @@ from linkedapi import (
     LinkedApi,
     LinkedApiConfig,
     RetrieveFeedParams,
+    SearchPostActor,
+    SearchPostResult,
+    SearchPostsCompanyFilter,
+    SearchPostsFilter,
+    SearchPostsParams,
+    SearchPostsPersonFilter,
     SimpleWorkflowMapper,
     VoidWorkflowMapper,
 )
@@ -33,6 +39,7 @@ def test_linked_api_exposes_all_predefined_operations() -> None:
         "search_companies",
         "nv_search_companies",
         "search_jobs",
+        "search_posts",
         "send_connection_request",
         "check_connection_status",
         "withdraw_connection_request",
@@ -67,7 +74,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) == 39
+    assert len(linkedapi.operations) == 40
 
 
 def test_operation_mappers_match_node_contract() -> None:
@@ -79,6 +86,8 @@ def test_operation_mappers_match_node_contract() -> None:
     assert linkedapi.search_people.mapper.base_action_type == "st.searchPeople"
     assert isinstance(linkedapi.search_jobs.mapper, ArrayWorkflowMapper)
     assert linkedapi.search_jobs.mapper.base_action_type == "st.searchJobs"
+    assert isinstance(linkedapi.search_posts.mapper, ArrayWorkflowMapper)
+    assert linkedapi.search_posts.mapper.base_action_type == "st.searchPosts"
     assert linkedapi.fetch_job.mapper.base_action_type == "st.openJob"
     assert linkedapi.fetch_job.mapper.default_params == {"basicInfo": True}
     assert isinstance(linkedapi.send_connection_request.mapper, VoidWorkflowMapper)
@@ -134,6 +143,153 @@ def test_retrieve_feed_maps_params_and_feed_context() -> None:
             RetrieveFeedParams(limit=invalid_limit)
 
 
+def test_search_posts_maps_filter_params_and_actors_without_urn() -> None:
+    linkedapi = LinkedApi(LinkedApiConfig(linked_api_token="x", identification_token="y"))
+
+    request = linkedapi.search_posts.mapper.map_request(
+        SearchPostsParams(
+            term="climate tech",
+            limit=20,
+            filter={
+                "sort": "latest",
+                "date_posted": "pastWeek",
+                "content_type": "images",
+                "posted_by": ["firstConnections", "peopleYouFollow"],
+                "from_members": [{"name": "Bill Gates", "urn": "urn:li:member:251749025"}],
+                "from_companies": ["Example Company"],
+                "mentioning_members": [],
+                "mentioning_companies": [],
+                "author_companies": [
+                    {"name": "Example Company", "urn": "urn:li:organization:1234567"}
+                ],
+                "author_industries": ["Software Development"],
+            },
+            custom_search_url=(
+                "https://www.linkedin.com/search/results/content/?keywords=climate%20tech"
+            ),
+        )
+    )
+
+    assert request == {
+        "actionType": "st.searchPosts",
+        "term": "climate tech",
+        "limit": 20,
+        "filter": {
+            "sort": "latest",
+            "datePosted": "pastWeek",
+            "contentType": "images",
+            "postedBy": ["firstConnections", "peopleYouFollow"],
+            "fromMembers": [{"name": "Bill Gates", "urn": "urn:li:member:251749025"}],
+            "fromCompanies": ["Example Company"],
+            "mentioningMembers": [],
+            "mentioningCompanies": [],
+            "authorCompanies": [{"name": "Example Company", "urn": "urn:li:organization:1234567"}],
+            "authorIndustries": ["Software Development"],
+        },
+        "customSearchUrl": "https://www.linkedin.com/search/results/content/?keywords=climate%20tech",
+    }
+
+    response = linkedapi.search_posts.mapper.map_response(
+        {
+            "actionType": "st.searchPosts",
+            "success": True,
+            "data": [
+                {
+                    "url": "https://www.linkedin.com/feed/update/urn:li:activity:1",
+                    "activityUrn": "urn:li:activity:1",
+                    "time": "2023-01-01T09:15:00Z",
+                    "type": "repost",
+                    "author": {
+                        "type": "company",
+                        "name": "Example Company",
+                        "companyUrl": "https://www.linkedin.com/company/example-company",
+                    },
+                    "reposter": {
+                        "type": "person",
+                        "name": "Example Reposter",
+                        "profileUrl": "https://www.linkedin.com/in/example-reposter",
+                        "headline": None,
+                    },
+                    "text": "Original post content about the webinar.",
+                    "repostText": "A useful summary for anyone planning a launch.",
+                    "hashtags": [],
+                    "mentions": [],
+                    "externalLinks": [],
+                    "images": [],
+                    "documentSlides": [],
+                    "hasVideo": True,
+                    "videoThumbnail": "https://media.licdn.com/dms/image/video-cover.jpg",
+                    "hasPoll": False,
+                    "reactionsCount": 6,
+                    "commentsCount": 0,
+                    "repostsCount": 1,
+                }
+            ],
+        }
+    )
+
+    assert response.data is not None
+    post = response.data[0]
+    assert isinstance(post, SearchPostResult)
+    assert post.activity_urn == "urn:li:activity:1"
+    assert post.author is not None
+    assert post.author.company_url == "https://www.linkedin.com/company/example-company"
+    assert post.reposter is not None
+    assert post.reposter.profile_url == "https://www.linkedin.com/in/example-reposter"
+    assert post.video_thumbnail == "https://media.licdn.com/dms/image/video-cover.jpg"
+    assert post.reposts_count == 1
+    # A search result never resolves an actor urn, so the field must not exist on this surface.
+    assert "urn" not in SearchPostActor.model_fields
+
+
+def test_search_posts_actor_filters_accept_bare_strings_and_objects_mixed() -> None:
+    params = SearchPostsParams(
+        term="ai",
+        filter=SearchPostsFilter(
+            from_members=[
+                "Bill Gates",
+                SearchPostsPersonFilter(
+                    name="Satya Nadella",
+                    person_hashed_url="https://www.linkedin.com/in/ACoAAABC",
+                ),
+            ],
+            from_companies=[
+                "Acme",
+                SearchPostsCompanyFilter(
+                    name="Globex",
+                    company_hashed_url="https://www.linkedin.com/company/1035",
+                ),
+            ],
+        ),
+    )
+
+    assert params.model_dump(by_alias=True, exclude_none=True) == {
+        "term": "ai",
+        "filter": {
+            "fromMembers": [
+                "Bill Gates",
+                {
+                    "name": "Satya Nadella",
+                    "personHashedUrl": "https://www.linkedin.com/in/ACoAAABC",
+                },
+            ],
+            "fromCompanies": [
+                "Acme",
+                {
+                    "name": "Globex",
+                    "companyHashedUrl": "https://www.linkedin.com/company/1035",
+                },
+            ],
+        },
+    }
+
+    with pytest.raises(ValidationError):
+        SearchPostsFilter(sort="mostRecent")
+
+    with pytest.raises(ValidationError):
+        SearchPostsFilter(from_members=[{"urn": "urn:li:member:1"}])
+
+
 def test_invitation_params_require_the_matching_target_url() -> None:
     params = AcceptInvitationParams(
         invitation_type="companyFollow",