update search with viewerState & connection degrees filter

Author: LordOfTheVillage

linkedapi/errors.py

@@ -17,13 +17,14 @@
     "connectionNotFound",
     "searchingNotAllowed",
     "searchInterfaceMismatch",
-    "filterIdentityMismatch",
+    "filterNotApplied",
     "companyNotFound",
     "postNotFound",
     "jobNotFound",
     "commentingNotAllowed",
     "commentNotFound",
     "replyingNotAllowed",
+    "duplicateComment",
     "noPostingPermission",
     "mentionNotResolved",
     "repostNotAllowed",
@@ -47,13 +48,14 @@
     "connectionNotFound",
     "searchingNotAllowed",
     "searchInterfaceMismatch",
-    "filterIdentityMismatch",
+    "filterNotApplied",
     "companyNotFound",
     "postNotFound",
     "jobNotFound",
     "commentingNotAllowed",
     "commentNotFound",
     "replyingNotAllowed",
+    "duplicateComment",
     "noPostingPermission",
     "mentionNotResolved",
     "repostNotAllowed",

linkedapi/types/__init__.py

@@ -156,6 +156,7 @@
     CommentOnPostParams,
     CommentOnPostResult,
     CommentResult,
+    ContentViewerState,
     CreatePostAttachment,
     CreatePostParams,
     CreatePostResult,
@@ -167,6 +168,7 @@
     PostActorType,
     PostAuthor,
     PostComment,
+    PostCommentAuthor,
     PostCommenterType,
     PostCommentsRetrievalConfig,
     PostCommentsSort,
@@ -231,6 +233,11 @@
     RetrievePerformanceResult,
     RetrieveSSIResult,
 )
+from linkedapi.types.viewer_state import (
+    ConnectionDegree,
+    NvConnectionDegreeFilter,
+    PersonViewerState,
+)
 from linkedapi.types.webhooks import (
     AccountWebhookEvent,
     AccountWebhookEventData,
@@ -300,11 +307,13 @@
     "CommentOnPostResult",
     "CommentResult",
     "Company",
+    "ConnectionDegree",
     "ConnectionPerson",
     "ConnectionSession",
     "ConnectionSessionResult",
     "ConnectionSessionStatus",
     "ConnectionStatus",
+    "ContentViewerState",
     "ConversationPollRequest",
     "ConversationPollResult",
     "ConversationType",
@@ -381,6 +390,7 @@
     "NvCompanyEmployee",
     "NvCompanyEmployeeFilter",
     "NvCompanyEmployeeRetrievalConfig",
+    "NvConnectionDegreeFilter",
     "NvFetchCompanyParams",
     "NvFetchCompanyResult",
     "NvManageConversationParams",
@@ -402,10 +412,12 @@
     "PersonExperience",
     "PersonLanguage",
     "PersonSkill",
+    "PersonViewerState",
     "Post",
     "PostActorType",
     "PostAuthor",
     "PostComment",
+    "PostCommentAuthor",
     "PostCommenterType",
     "PostCommentsRetrievalConfig",
     "PostCommentsSort",

linkedapi/types/company.py

@@ -8,6 +8,11 @@
 from linkedapi.types.params import BaseActionParams, LimitParams, LimitSinceParams
 from linkedapi.types.person import YearsOfExperience
 from linkedapi.types.post import Post
+from linkedapi.types.viewer_state import (
+    ConnectionDegree,
+    NvConnectionDegreeFilter,
+    PersonViewerState,
+)
 
 
 class StCompanyEmployee(LinkedApiModel):
@@ -17,6 +22,7 @@ class StCompanyEmployee(LinkedApiModel):
     headline: str | None = None
     location: str | None = None
     avatar_url: str | None = None
+    viewer_state: PersonViewerState | None = None
 
 
 class StCompanyDm(LinkedApiModel):
@@ -27,6 +33,7 @@ class StCompanyDm(LinkedApiModel):
     location: str | None = None
     avatar_url: str | None = None
     country_code: str | None = None
+    viewer_state: PersonViewerState | None = None
 
 
 class Company(LinkedApiModel):
@@ -69,6 +76,7 @@ class StCompanyEmployeesFilter(LinkedApiModel):
     locations: list[str] | None = None
     industries: list[str] | None = None
     schools: list[str] | None = None
+    connection_degrees: list[ConnectionDegree] | None = None
 
 
 class StCompanyEmployeesRetrievalConfig(LimitParams):
@@ -91,6 +99,7 @@ class NvCompanyEmployee(LinkedApiModel):
     position: str | None = None
     location: str | None = None
     avatar_url: str | None = None
+    viewer_state: PersonViewerState | None = None
 
 
 class NvCompanyDm(LinkedApiModel):
@@ -101,6 +110,7 @@ class NvCompanyDm(LinkedApiModel):
     location: str | None = None
     avatar_url: str | None = None
     country_code: str | None = None
+    viewer_state: PersonViewerState | None = None
 
 
 class NvCompany(LinkedApiModel):
@@ -138,6 +148,7 @@ class NvCompanyEmployeeFilter(LinkedApiModel):
     industries: list[str] | None = None
     schools: list[str] | None = None
     years_of_experiences: list[YearsOfExperience] | None = None
+    connection_degrees: list[NvConnectionDegreeFilter] | None = None
 
 
 class NvCompanyEmployeeRetrievalConfig(LimitParams):

linkedapi/types/person.py

@@ -4,6 +4,7 @@
 
 from linkedapi.types.params import BaseActionParams, LimitSinceParams
 from linkedapi.types.post import Comment, Post, Reaction
+from linkedapi.types.viewer_state import PersonViewerState
 
 EmploymentType = Literal[
     "fullTime",
@@ -95,6 +96,7 @@ class Person(BaseActionParams):
     followers_count: int | None = None
     about: str | None = None
     avatar_url: str | None = None
+    viewer_state: PersonViewerState | None = None
     experiences: list[PersonExperience] | None = None
     education: list[PersonEducation] | None = None
     skills: list[PersonSkill] | None = None

linkedapi/types/post.py

@@ -4,6 +4,7 @@
 
 from linkedapi.types.base import LinkedApiModel
 from linkedapi.types.params import BaseActionParams, LimitParams
+from linkedapi.types.viewer_state import PersonViewerState
 
 PostType = Literal["original", "repost"]
 PostActorType = Literal["person", "company"]
@@ -14,6 +15,18 @@
 AttachmentType = Literal["image", "video", "document"]
 
 
+class ContentViewerState(LinkedApiModel):
+    """What your account has done with a post or a comment.
+
+    "reaction" is None if you have not reacted or the page does not show it; comments read in the
+    feed always report None. "is_own" is None if this cannot be told; content published as a
+    company page you administer is False.
+    """
+
+    reaction: ReactionType | None = None
+    is_own: bool | None = None
+
+
 class Reaction(LinkedApiModel):
     post_url: str | None = None
     time: str | None = None
@@ -69,9 +82,22 @@ class ReplyToCommentParams(BaseActionParams):
 ReplyToCommentResult: TypeAlias = CommentResult
 
 
+class PostCommentAuthor(LinkedApiModel):
+    """The commenter in the same actor shape a post's author has."""
+
+    type: PostActorType | None = None
+    name: str | None = None
+    profile_url: str | None = None
+    headline: str | None = None
+    company_url: str | None = None
+    viewer_state: PersonViewerState | None = None
+
+
 class PostComment(LinkedApiModel):
     comment_urn: str | None = None
     comment_url: str | None = None
+    author: PostCommentAuthor | None = None
+    # Deprecated: use "author" instead of the four commenter_* fields.
     commenter_url: str | None = None
     commenter_name: str | None = None
     commenter_headline: str | None = None
@@ -82,6 +108,7 @@ class PostComment(LinkedApiModel):
     is_reply: bool | None = None
     reactions_count: int | None = None
     replies_count: int | None = None
+    viewer_state: ContentViewerState | None = None
 
 
 class PostReaction(LinkedApiModel):
@@ -100,8 +127,11 @@ class PostAuthor(LinkedApiModel):
     profile_url: str | None = None
     headline: str | None = None
     company_url: str | None = None
+    # Set for a person author only.
+    viewer_state: PersonViewerState | None = None
 
 
+# A reposter carries no viewer_state: only the author's relation to your account is reported.
 class PostReposter(LinkedApiModel):
     type: PostActorType | None = None
     name: str | None = None
@@ -131,6 +161,7 @@ class Post(LinkedApiModel):
     reactions_count: int | None = None
     comments_count: int | None = None
     reposts_count: int | None = None
+    viewer_state: ContentViewerState | None = None
     comments: list[PostComment] | None = None
     reactions: list[PostReaction] | None = None
 

linkedapi/types/search_people.py

@@ -3,6 +3,11 @@
 from linkedapi.types.base import LinkedApiModel
 from linkedapi.types.params import BaseActionParams, LimitParams
 from linkedapi.types.person import YearsOfExperience
+from linkedapi.types.viewer_state import (
+    ConnectionDegree,
+    NvConnectionDegreeFilter,
+    PersonViewerState,
+)
 
 
 class SearchPeopleFilter(LinkedApiModel):
@@ -14,6 +19,7 @@ class SearchPeopleFilter(LinkedApiModel):
     current_companies: list[str] | None = None
     previous_companies: list[str] | None = None
     schools: list[str] | None = None
+    connection_degrees: list[ConnectionDegree] | None = None
 
 
 class SearchPeopleParams(BaseActionParams, LimitParams):
@@ -29,10 +35,12 @@ class SearchPeopleResult(LinkedApiModel):
     headline: str | None = None
     location: str | None = None
     avatar_url: str | None = None
+    viewer_state: PersonViewerState | None = None
 
 
 class NvSearchPeopleFilter(SearchPeopleFilter):
-    years_of_experience: list[YearsOfExperience] | None = None
+    years_of_experiences: list[YearsOfExperience] | None = None
+    connection_degrees: list[NvConnectionDegreeFilter] | None = None  # type: ignore[assignment]
 
 
 class NvSearchPeopleParams(BaseActionParams, LimitParams):
@@ -48,3 +56,4 @@ class NvSearchPeopleResult(LinkedApiModel):
     position: str | None = None
     location: str | None = None
     avatar_url: str | None = None
+    viewer_state: PersonViewerState | None = None

linkedapi/types/search_posts.py

@@ -4,7 +4,8 @@
 
 from linkedapi.types.base import LinkedApiModel
 from linkedapi.types.params import BaseActionParams, LimitParams
-from linkedapi.types.post import PostActorType, PostType
+from linkedapi.types.post import ContentViewerState, PostActorType, PostType
+from linkedapi.types.viewer_state import PersonViewerState
 
 PostSearchSort = Literal["topMatch", "latest"]
 PostSearchDatePosted = Literal["past24Hours", "pastWeek", "pastMonth"]
@@ -78,6 +79,8 @@ class SearchPostActor(LinkedApiModel):
     profile_url: str | None = None
     headline: str | None = None
     company_url: str | None = None
+    # Set for a person author only; a reposter carries none.
+    viewer_state: PersonViewerState | None = None
 
 
 class SearchPostResult(LinkedApiModel):
@@ -101,3 +104,4 @@ class SearchPostResult(LinkedApiModel):
     reactions_count: int | None = None
     comments_count: int | None = None
     reposts_count: int | None = None
+    viewer_state: ContentViewerState | None = None

linkedapi/types/viewer_state.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from linkedapi.types.base import LinkedApiModel
+
+# Your connection degree to a person, as LinkedIn shows it next to their name.
+ConnectionDegree = Literal["1st", "2nd", "3rd+"]
+# Sales Navigator also filters by members of the groups you belong to.
+NvConnectionDegreeFilter = Literal["1st", "2nd", "3rd+", "groupMembers"]
+
+
+class PersonViewerState(LinkedApiModel):
+    """How your account relates to a person.
+
+    "connection_degree" is None when LinkedIn shows no degree, e.g. on your own content.
+    """
+
+    connection_degree: ConnectionDegree | None = None

pyproject.toml

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

tests/test_errors.py

@@ -46,13 +46,14 @@ def test_error_type_sets_match_node_contract() -> None:
         "connectionNotFound",
         "searchingNotAllowed",
         "searchInterfaceMismatch",
-        "filterIdentityMismatch",
+        "filterNotApplied",
         "companyNotFound",
         "postNotFound",
         "jobNotFound",
         "commentingNotAllowed",
         "commentNotFound",
         "replyingNotAllowed",
+        "duplicateComment",
         "noPostingPermission",
         "mentionNotResolved",
         "repostNotAllowed",