linkedapi 1.3.7__tar.gz → 1.3.10__tar.gz

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

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

@@ -63,6 +63,7 @@ from linkedapi.operations import (
     RetrieveInvitations,
     RetrievePendingRequests,
     RetrievePerformance,
+    RetrieveProfileViewers,
     RetrieveSSI,
     SearchCompanies,
     SearchJobs,
@@ -78,7 +79,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.7"
+__version__ = "1.3.9"
 PredefinedOperation = Operation
 
 __all__ = [
@@ -140,6 +141,7 @@ __all__ = [
     "RetrieveFeed",
     "RetrievePendingRequests",
     "RetrievePerformance",
+    "RetrieveProfileViewers",
     "RetrieveSSI",
     "SearchCompanies",
     "SearchJobs",

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

@@ -36,6 +36,7 @@ from linkedapi.operations import (
     RetrieveInvitations,
     RetrievePendingRequests,
     RetrievePerformance,
+    RetrieveProfileViewers,
     RetrieveSSI,
     SearchCompanies,
     SearchJobs,
@@ -98,6 +99,7 @@ class LinkedApi:
         self.retrieve_feed = RetrieveFeed(self.http_client)
         self.retrieve_ssi = RetrieveSSI(self.http_client)
         self.retrieve_performance = RetrievePerformance(self.http_client)
+        self.retrieve_profile_viewers = RetrieveProfileViewers(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)
@@ -138,6 +140,7 @@ class LinkedApi:
             self.retrieve_feed,
             self.retrieve_ssi,
             self.retrieve_performance,
+            self.retrieve_profile_viewers,
             self.nv_send_message,
             self.nv_sync_conversation,
             self.nv_sync_inbox,

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

@@ -16,6 +16,7 @@ LinkedApiActionErrorType = Literal[
     "retrievingNotAllowed",
     "connectionNotFound",
     "searchingNotAllowed",
+    "searchInterfaceMismatch",
     "companyNotFound",
     "postNotFound",
     "jobNotFound",
@@ -41,6 +42,7 @@ LINKED_API_ACTION_ERROR_TYPES: tuple[str, ...] = (
     "retrievingNotAllowed",
     "connectionNotFound",
     "searchingNotAllowed",
+    "searchInterfaceMismatch",
     "companyNotFound",
     "postNotFound",
     "jobNotFound",

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

@@ -26,6 +26,7 @@ from linkedapi.operations.retrieve_feed import RetrieveFeed
 from linkedapi.operations.retrieve_invitations import RetrieveInvitations
 from linkedapi.operations.retrieve_pending_requests import RetrievePendingRequests
 from linkedapi.operations.retrieve_performance import RetrievePerformance
+from linkedapi.operations.retrieve_profile_viewers import RetrieveProfileViewers
 from linkedapi.operations.retrieve_ssi import RetrieveSSI
 from linkedapi.operations.search_companies import SearchCompanies
 from linkedapi.operations.search_jobs import SearchJobs
@@ -72,6 +73,7 @@ __all__ = [
     "RetrieveInvitations",
     "RetrievePendingRequests",
     "RetrievePerformance",
+    "RetrieveProfileViewers",
     "RetrieveSSI",
     "SearchCompanies",
     "SearchJobs",

linkedapi-1.3.10/linkedapi/operations/retrieve_profile_viewers.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import ArrayWorkflowMapper
+from linkedapi.types import ProfileViewer, RetrieveProfileViewersParams
+
+
+class RetrieveProfileViewers(Operation[RetrieveProfileViewersParams, list[ProfileViewer]]):
+    """Retrieve the viewers visible on the current account's LinkedIn profile."""
+
+    operation_name = "retrieveProfileViewers"
+    mapper = ArrayWorkflowMapper[RetrieveProfileViewersParams, ProfileViewer](
+        "st.retrieveProfileViewers",
+        ProfileViewer,
+    )

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

@@ -96,12 +96,15 @@ from linkedapi.types.jobs import (
     JobDatePosted,
     JobEmploymentType,
     JobExperienceLevel,
+    JobPreferenceEmploymentType,
+    JobPreferenceExperienceLevel,
     JobSalary,
     JobWorkplaceType,
     SalaryPeriod,
     SearchJobResult,
     SearchJobsFilter,
     SearchJobsParams,
+    SearchJobsPreferences,
 )
 from linkedapi.types.message import (
     ConversationPollRequest,
@@ -177,6 +180,11 @@ from linkedapi.types.post import (
     ReplyToCommentParams,
     ReplyToCommentResult,
 )
+from linkedapi.types.profile_viewers import (
+    ProfileViewer,
+    ProfileViewerType,
+    RetrieveProfileViewersParams,
+)
 from linkedapi.types.responses import LinkedApiRequestError, LinkedApiResponse
 from linkedapi.types.search_companies import (
     AnnualRevenueFilter,
@@ -315,6 +323,8 @@ __all__ = [
     "JobDatePosted",
     "JobEmploymentType",
     "JobExperienceLevel",
+    "JobPreferenceEmploymentType",
+    "JobPreferenceExperienceLevel",
     "JobSalary",
     "JobWorkplaceType",
     "LanguageProficiency",
@@ -383,6 +393,8 @@ __all__ = [
     "PostReactionsRetrievalConfig",
     "PostReposter",
     "PostType",
+    "ProfileViewer",
+    "ProfileViewerType",
     "ReactToCommentParams",
     "ReactToPostParams",
     "Reaction",
@@ -402,6 +414,7 @@ __all__ = [
     "RetrieveFeedParams",
     "RetrievePendingRequestsResult",
     "RetrievePerformanceResult",
+    "RetrieveProfileViewersParams",
     "RetrieveSSIResult",
     "SalaryPeriod",
     "SearchCompaniesFilter",
@@ -411,6 +424,7 @@ __all__ = [
     "SearchJobResult",
     "SearchJobsFilter",
     "SearchJobsParams",
+    "SearchJobsPreferences",
     "SearchPeopleFilter",
     "SearchPeopleParams",
     "SearchPeopleResult",

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/company.py

@@ -12,21 +12,26 @@ from linkedapi.types.post import Post
 
 class StCompanyEmployee(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     headline: str | None = None
     location: str | None = None
+    avatar_url: str | None = None
 
 
 class StCompanyDm(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     headline: str | None = None
     location: str | None = None
+    avatar_url: str | None = None
     country_code: str | None = None
 
 
 class Company(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     description: str | None = None
     location: str | None = None
@@ -81,21 +86,26 @@ FetchCompanyResult: TypeAlias = Company
 
 class NvCompanyEmployee(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     hashed_url: str | None = None
     position: str | None = None
     location: str | None = None
+    avatar_url: str | None = None
 
 
 class NvCompanyDm(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     hashed_url: str | None = None
     position: str | None = None
     location: str | None = None
+    avatar_url: str | None = None
     country_code: str | None = None
 
 
 class NvCompany(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     description: str | None = None
     location: str | None = None

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/connection.py

@@ -40,6 +40,7 @@ class WithdrawConnectionRequestParams(BaseActionParams):
 
 class RetrievePendingRequestsResult(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     headline: str | None = None
     sent_time: str | None = None
@@ -78,6 +79,7 @@ class IgnoreInvitationParams(InvitationTargetParams):
 class Invitation(LinkedApiModel):
     invitation_type: InvitationType
     name: str
+    urn: str | None = None
     public_url: str
     headline: str | None = None
     note: str | None = None
@@ -146,10 +148,12 @@ class RetrieveConnectionsParams(LimitParams):
 
 class RetrieveConnectionsResult(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     headline: str | None = None
     location: str | None = None
     connected_at: str | None = None
+    avatar_url: str | None = None
 
 
 class RemoveConnectionParams(BaseActionParams):
@@ -162,6 +166,7 @@ class NvOpenPersonPageParams(BaseActionParams):
 
 class NvOpenPersonPageResult(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     hashed_url: str | None = None
     headline: str | None = None
@@ -169,4 +174,6 @@ class NvOpenPersonPageResult(LinkedApiModel):
     country_code: str | None = None
     position: str | None = None
     company_name: str | None = None
+    company_urn: str | None = None
     company_hashed_url: str | None = None
+    avatar_url: str | None = None

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/jobs.py

@@ -24,6 +24,24 @@ JobEmploymentType = Literal[
     "other",
 ]
 JobWorkplaceType = Literal["onSite", "remote", "hybrid"]
+# Experience levels of LinkedIn's AI-powered jobs search. Not a subset of JobExperienceLevel:
+# "senior" corresponds to "midSeniorLevel", "manager" has no classic equivalent, and "internship"
+# and "associate" are absent here.
+JobPreferenceExperienceLevel = Literal[
+    "entryLevel",
+    "senior",
+    "manager",
+    "director",
+    "executive",
+]
+# Same names as JobEmploymentType, minus "temporary" and "other".
+JobPreferenceEmploymentType = Literal[
+    "fullTime",
+    "partTime",
+    "contract",
+    "internship",
+    "volunteer",
+]
 SalaryPeriod = Literal["yearly", "monthly", "hourly"]
 JobCurrency = Literal[
     "usd",
@@ -74,6 +92,12 @@ class JobSalary(LinkedApiModel):
 
 
 class SearchJobsFilter(LinkedApiModel):
+    """Filtering criteria for the classic LinkedIn jobs search.
+
+    Every specified field is applied, or the action fails.
+    """
+
+    # Deprecated: use the top-level "location" of SearchJobsParams instead.
     location: str | None = None
     date_posted: JobDatePosted | None = None
     experience_levels: list[JobExperienceLevel] | None = None
@@ -89,14 +113,38 @@ class SearchJobsFilter(LinkedApiModel):
     fair_chance_employer: bool | None = None
 
 
+class SearchJobsPreferences(LinkedApiModel):
+    """Filtering criteria for LinkedIn's AI-powered jobs search.
+
+    LinkedIn decides which of them it offers for a given search, and the ones it does not offer are
+    skipped instead of failing the action.
+    """
+
+    date_posted: JobDatePosted | None = None
+    experience_levels: list[JobPreferenceExperienceLevel] | None = None
+    employment_types: list[JobPreferenceEmploymentType] | None = None
+    companies: list[str] | None = None
+    remote: bool | None = None
+    easy_apply: bool | None = None
+    under_10_applicants: bool | None = None
+    in_your_network: bool | None = None
+    keywords: list[str] | None = None
+
+
 class SearchJobsParams(BaseActionParams, LimitParams):
     term: str | None = None
+    location: str | None = None
+    allow_similar_results: bool | None = None
+    # "filter" and "preferences" are mutually exclusive: "filter" targets the classic LinkedIn jobs
+    # search, "preferences" the AI-powered one.
     filter: SearchJobsFilter | None = None
+    preferences: SearchJobsPreferences | None = None
     custom_search_url: str | None = None
 
 
 class SearchJobResult(LinkedApiModel):
     job_id: str | None = None
+    urn: str | None = None
     job_url: str | None = None
     title: str | None = None
     company_name: str | None = None
@@ -105,6 +153,7 @@ class SearchJobResult(LinkedApiModel):
     salary: JobSalary | None = None
     easy_apply: bool | None = None
     is_promoted: bool | None = None
+    is_similar_match: bool | None = None
 
 
 class FetchJobParams(BaseActionParams):
@@ -113,6 +162,7 @@ class FetchJobParams(BaseActionParams):
 
 class Job(LinkedApiModel):
     job_id: str | None = None
+    urn: str | None = None
     job_url: str | None = None
     title: str | None = None
     company_name: str | None = None

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/message.py

@@ -78,6 +78,7 @@ class Message(LinkedApiModel):
 
 
 class ConversationPollResult(LinkedApiModel):
+    person_urn: str | None = None
     person_url: str | None = None
     type: ConversationType | None = None
     messages: list[Message] | None = None
@@ -95,6 +96,10 @@ class InboxMessage(LinkedApiModel):
     id: str | None = None
     type: ConversationType | None = None
     thread_id: str | None = None
+    person_urn: str | None = None
+    person_hashed_url: str | None = None
+    person_public_url: str | None = None
+    # Deprecated: use person_hashed_url. Still returned by the API for compatibility.
     person_url: str | None = None
     sender: MessageSender | None = None
     text: str | None = None

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/network.py

@@ -24,5 +24,6 @@ class NetworkPollRequest(LinkedApiModel):
 class NetworkEvent(LinkedApiModel):
     id: str | None = None
     type: NetworkEventType | None = None
+    person_urn: str | None = None
     person_url: str | None = None
     detected_at: str | None = None

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/person.py

@@ -83,6 +83,7 @@ class PersonLanguage(BaseActionParams):
 
 class Person(BaseActionParams):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     hashed_url: str | None = None
     headline: str | None = None

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/post.py

@@ -77,6 +77,7 @@ class PostComment(LinkedApiModel):
 
 
 class PostReaction(LinkedApiModel):
+    engager_urn: str | None = None
     engager_url: str | None = None
     engager_name: str | None = None
     engager_headline: str | None = None
@@ -87,6 +88,7 @@ class PostReaction(LinkedApiModel):
 class PostAuthor(LinkedApiModel):
     type: PostActorType | None = None
     name: str | None = None
+    urn: str | None = None
     profile_url: str | None = None
     headline: str | None = None
     company_url: str | None = None
@@ -95,6 +97,7 @@ class PostAuthor(LinkedApiModel):
 class PostReposter(LinkedApiModel):
     type: PostActorType | None = None
     name: str | None = None
+    urn: str | None = None
     profile_url: str | None = None
     headline: str | None = None
     company_url: str | None = None

linkedapi-1.3.10/linkedapi/types/profile_viewers.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from pydantic import Field, model_validator
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams
+
+ProfileViewerType = Literal["identified", "anonymous"]
+
+
+class RetrieveProfileViewersParams(BaseActionParams):
+    limit: int | None = Field(default=None, ge=1, le=300)
+    since: str | None = None
+
+
+class ProfileViewer(LinkedApiModel):
+    viewer_type: ProfileViewerType
+    viewed_at: str | None
+    viewed_ago: str | None
+    name: str | None = None
+    public_url: str | None = None
+    urn: str | None = None
+    headline: str | None = None
+    connection_degree: Literal[1, 2, 3] | None = None
+    avatar_url: str | None = None
+    description: str | None = None
+    search_url: str | None = None
+
+    @model_validator(mode="after")
+    def validate_type_fields(self) -> ProfileViewer:
+        type_fields = {
+            "name",
+            "public_url",
+            "urn",
+            "headline",
+            "connection_degree",
+            "avatar_url",
+            "description",
+            "search_url",
+        }
+        required_fields = {
+            "identified": {
+                "name",
+                "public_url",
+                "urn",
+                "headline",
+                "connection_degree",
+                "avatar_url",
+            },
+            "anonymous": {"description", "search_url"},
+        }[self.viewer_type]
+        missing_fields = required_fields - self.model_fields_set
+        if missing_fields:
+            msg = (
+                f"{self.viewer_type} profile viewer is missing required fields: "
+                f"{', '.join(sorted(missing_fields))}"
+            )
+            raise ValueError(msg)
+
+        unexpected_fields = (self.model_fields_set & type_fields) - required_fields
+        if unexpected_fields:
+            msg = (
+                f"{self.viewer_type} profile viewer contains fields for another type: "
+                f"{', '.join(sorted(unexpected_fields))}"
+            )
+            raise ValueError(msg)
+
+        required_values = {
+            "identified": {"name": self.name, "public_url": self.public_url},
+            "anonymous": {"description": self.description, "search_url": self.search_url},
+        }[self.viewer_type]
+        null_fields = [name for name, value in required_values.items() if value is None]
+        if null_fields:
+            msg = (
+                f"{self.viewer_type} profile viewer requires non-null fields: "
+                f"{', '.join(sorted(null_fields))}"
+            )
+            raise ValueError(msg)
+
+        return self

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/search_companies.py

@@ -45,6 +45,7 @@ class SearchCompaniesParams(BaseActionParams, LimitParams):
 
 class SearchCompanyResult(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     industry: str | None = None
     location: str | None = None
@@ -68,6 +69,7 @@ class NvSearchCompaniesParams(BaseActionParams, LimitParams):
 
 class NvSearchCompanyResult(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     hashed_url: str | None = None
     industry: str | None = None
     employees_count: int | None = None

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/search_people.py

@@ -24,6 +24,7 @@ class SearchPeopleParams(BaseActionParams, LimitParams):
 
 class SearchPeopleResult(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     public_url: str | None = None
     headline: str | None = None
     location: str | None = None
@@ -42,6 +43,7 @@ class NvSearchPeopleParams(BaseActionParams, LimitParams):
 
 class NvSearchPeopleResult(LinkedApiModel):
     name: str | None = None
+    urn: str | None = None
     hashed_url: str | None = None
     position: str | None = None
     location: str | None = None

{linkedapi-1.3.7 → linkedapi-1.3.10}/linkedapi/types/webhooks.py

@@ -101,6 +101,10 @@ class MessageWebhookEventData(LinkedApiModel):
     account_id: str | None = None
     type: ConversationType | None = None
     thread_id: str | None = None
+    person_urn: str | None = None
+    person_hashed_url: str | None = None
+    person_public_url: str | None = None
+    # Deprecated: use person_hashed_url. Still returned by the API for compatibility.
     person_url: str | None = None
     message_id: str | None = None
     sender: MessageSender | None = None
@@ -117,6 +121,7 @@ class MessageWebhookEvent(LinkedApiModel):
 
 class NetworkWebhookEventData(LinkedApiModel):
     account_id: str | None = None
+    person_urn: str | None = None
     person_url: str | None = None
     detected_at: str | None = None
 

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

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

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

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

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

@@ -59,6 +59,7 @@ def test_linked_api_exposes_all_predefined_operations() -> None:
         "create_post",
         "retrieve_ssi",
         "retrieve_performance",
+        "retrieve_profile_viewers",
     ]
 
     for name in operation_names:
@@ -66,7 +67,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) == 38
+    assert len(linkedapi.operations) == 39
 
 
 def test_operation_mappers_match_node_contract() -> None: