linkedapi 1.0.0__py3-none-any.whl

linkedapi/operations/search_companies.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import ArrayWorkflowMapper
+from linkedapi.types import SearchCompaniesParams, SearchCompanyResult
+
+
+class SearchCompanies(Operation[SearchCompaniesParams, list[SearchCompanyResult]]):
+    """Search companies on standard LinkedIn."""
+
+    operation_name = "searchCompanies"
+    mapper = ArrayWorkflowMapper[SearchCompaniesParams, SearchCompanyResult](
+        "st.searchCompanies",
+        SearchCompanyResult,
+    )

linkedapi/operations/search_people.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import ArrayWorkflowMapper
+from linkedapi.types import SearchPeopleParams, SearchPeopleResult
+
+
+class SearchPeople(Operation[SearchPeopleParams, list[SearchPeopleResult]]):
+    """Search people on standard LinkedIn."""
+
+    operation_name = "searchPeople"
+    mapper = ArrayWorkflowMapper[SearchPeopleParams, SearchPeopleResult](
+        "st.searchPeople",
+        SearchPeopleResult,
+    )

linkedapi/operations/send_connection_request.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import VoidWorkflowMapper
+from linkedapi.types import SendConnectionRequestParams
+
+
+class SendConnectionRequest(Operation[SendConnectionRequestParams, None]):
+    """Send a standard LinkedIn connection request."""
+
+    operation_name = "sendConnectionRequest"
+    mapper = VoidWorkflowMapper[SendConnectionRequestParams]("st.sendConnectionRequest")

linkedapi/operations/send_message.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import VoidWorkflowMapper
+from linkedapi.types import SendMessageParams
+
+
+class SendMessage(Operation[SendMessageParams, None]):
+    """Send a standard LinkedIn message."""
+
+    operation_name = "sendMessage"
+    mapper = VoidWorkflowMapper[SendMessageParams]("st.sendMessage")

linkedapi/operations/sync_conversation.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import VoidWorkflowMapper
+from linkedapi.types import SyncConversationParams
+
+
+class SyncConversation(Operation[SyncConversationParams, None]):
+    """Sync a standard LinkedIn conversation."""
+
+    operation_name = "syncConversation"
+    mapper = VoidWorkflowMapper[SyncConversationParams]("st.syncConversation")

linkedapi/operations/withdraw_connection_request.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from linkedapi.core import Operation
+from linkedapi.mappers import VoidWorkflowMapper
+from linkedapi.types import WithdrawConnectionRequestParams
+
+
+class WithdrawConnectionRequest(Operation[WithdrawConnectionRequestParams, None]):
+    """Withdraw a pending standard LinkedIn connection request."""
+
+    operation_name = "withdrawConnectionRequest"
+    mapper = VoidWorkflowMapper[WithdrawConnectionRequestParams]("st.withdrawConnectionRequest")

linkedapi/py.typed

@@ -0,0 +1 @@
+

linkedapi/types/__init__.py

@@ -0,0 +1,336 @@
+from linkedapi.types.account import AccountInfo
+from linkedapi.types.admin import (
+    AccountsResult,
+    AdminAccount,
+    AdminAccountStatus,
+    AdminConfig,
+    BillingLinkResult,
+    BillingPeriod,
+    CancelConnectionSessionParams,
+    CancelResult,
+    ConnectionSession,
+    ConnectionSessionResult,
+    ConnectionSessionStatus,
+    CreateConnectionSessionResult,
+    Currency,
+    DeleteLimitEntry,
+    DeleteLimitsParams,
+    DisconnectParams,
+    GetConnectionSessionParams,
+    GetLimitsParams,
+    GetLimitsUsageParams,
+    Limit,
+    LimitCategory,
+    LimitPeriod,
+    LimitsResult,
+    LimitUsage,
+    LimitUsageResult,
+    PendingConnectionSession,
+    RegenerateTokenParams,
+    RegenerateTokenResult,
+    ResetLimitsParams,
+    SeatType,
+    SetLimitEntry,
+    SetLimitsParams,
+    SetSeatsParams,
+    SetSeatsResult,
+    SetSeatsStatus,
+    SubscriptionPricingResult,
+    SubscriptionProduct,
+    SubscriptionSeat,
+    SubscriptionSeatsResult,
+    SubscriptionStatus,
+    SubscriptionStatusValue,
+)
+from linkedapi.types.base import (
+    LinkedApiModel,
+    dump_model_by_name,
+    serialize_model,
+    serialize_value,
+)
+from linkedapi.types.company import (
+    BaseFetchCompanyParams,
+    BaseFetchCompanyParamsWide,
+    Company,
+    FetchCompanyParams,
+    FetchCompanyResult,
+    NvBaseFetchCompanyParams,
+    NvBaseFetchCompanyParamsWide,
+    NvCompany,
+    NvCompanyDm,
+    NvCompanyEmployee,
+    NvCompanyEmployeeFilter,
+    NvCompanyEmployeeRetrievalConfig,
+    NvFetchCompanyParams,
+    NvFetchCompanyResult,
+    StCompanyDm,
+    StCompanyEmployee,
+    StCompanyEmployeesFilter,
+    StCompanyEmployeesRetrievalConfig,
+)
+from linkedapi.types.connection import (
+    CheckConnectionStatusParams,
+    CheckConnectionStatusResult,
+    ConnectionPerson,
+    ConnectionStatus,
+    NvOpenPersonPageParams,
+    NvOpenPersonPageResult,
+    RemoveConnectionParams,
+    RetrieveConnectionsFilter,
+    RetrieveConnectionsParams,
+    RetrieveConnectionsResult,
+    RetrievePendingRequestsResult,
+    SendConnectionRequestParams,
+    WithdrawConnectionRequestParams,
+)
+from linkedapi.types.message import (
+    ConversationPollRequest,
+    ConversationPollResult,
+    ConversationType,
+    Message,
+    MessageSender,
+    NvSendMessageParams,
+    NvSyncConversationParams,
+    SendMessageParams,
+    SyncConversationParams,
+)
+from linkedapi.types.params import BaseActionParams, LimitParams, LimitSinceParams
+from linkedapi.types.person import (
+    BaseFetchPersonParams,
+    BaseFetchPersonParamsWide,
+    EmploymentType,
+    FetchPersonParams,
+    FetchPersonResult,
+    LanguageProficiency,
+    LocationType,
+    Person,
+    PersonEducation,
+    PersonExperience,
+    PersonLanguage,
+    PersonSkill,
+    YearsOfExperience,
+)
+from linkedapi.types.post import (
+    AttachmentType,
+    BaseFetchPostParams,
+    BaseFetchPostParamsWide,
+    Comment,
+    CommentOnPostParams,
+    CreatePostAttachment,
+    CreatePostParams,
+    CreatePostResult,
+    FetchPostParams,
+    FetchPostResult,
+    Post,
+    PostComment,
+    PostCommenterType,
+    PostCommentsRetrievalConfig,
+    PostCommentsSort,
+    PostEngagerType,
+    PostReaction,
+    PostReactionsRetrievalConfig,
+    PostType,
+    Reaction,
+    ReactionType,
+    ReactToPostParams,
+)
+from linkedapi.types.responses import LinkedApiRequestError, LinkedApiResponse
+from linkedapi.types.search_companies import (
+    AnnualRevenueFilter,
+    MaxAnnualRevenue,
+    MinAnnualRevenue,
+    NvSearchCompaniesFilter,
+    NvSearchCompaniesParams,
+    NvSearchCompanyResult,
+    SearchCompaniesFilter,
+    SearchCompaniesParams,
+    SearchCompanyResult,
+    SearchCompanySize,
+)
+from linkedapi.types.search_people import (
+    NvSearchPeopleFilter,
+    NvSearchPeopleParams,
+    NvSearchPeopleResult,
+    SearchPeopleFilter,
+    SearchPeopleParams,
+    SearchPeopleResult,
+)
+from linkedapi.types.statistics import (
+    ApiUsageAction,
+    ApiUsageParams,
+    RetrievePerformanceResult,
+    RetrieveSSIResult,
+)
+from linkedapi.types.workflow import (
+    LinkedApiActionError,
+    WorkflowCancelResponse,
+    WorkflowCompletion,
+    WorkflowCompletionSingleAction,
+    WorkflowDefinition,
+    WorkflowFailure,
+    WorkflowInProgressResponse,
+    WorkflowInProgressStatus,
+    WorkflowResponse,
+    WorkflowStartedResponse,
+    WorkflowStatus,
+)
+
+__all__ = [
+    "AccountInfo",
+    "AccountsResult",
+    "AdminAccount",
+    "AdminAccountStatus",
+    "AdminConfig",
+    "AnnualRevenueFilter",
+    "ApiUsageAction",
+    "ApiUsageParams",
+    "AttachmentType",
+    "BaseActionParams",
+    "BaseFetchCompanyParams",
+    "BaseFetchCompanyParamsWide",
+    "BaseFetchPersonParams",
+    "BaseFetchPersonParamsWide",
+    "BaseFetchPostParams",
+    "BaseFetchPostParamsWide",
+    "BillingLinkResult",
+    "BillingPeriod",
+    "CancelConnectionSessionParams",
+    "CancelResult",
+    "CheckConnectionStatusParams",
+    "CheckConnectionStatusResult",
+    "Comment",
+    "CommentOnPostParams",
+    "Company",
+    "ConnectionPerson",
+    "ConnectionSession",
+    "ConnectionSessionResult",
+    "ConnectionSessionStatus",
+    "ConnectionStatus",
+    "ConversationPollRequest",
+    "ConversationPollResult",
+    "ConversationType",
+    "CreateConnectionSessionResult",
+    "CreatePostAttachment",
+    "CreatePostParams",
+    "CreatePostResult",
+    "Currency",
+    "DeleteLimitEntry",
+    "DeleteLimitsParams",
+    "DisconnectParams",
+    "EmploymentType",
+    "FetchCompanyParams",
+    "FetchCompanyResult",
+    "FetchPersonParams",
+    "FetchPersonResult",
+    "FetchPostParams",
+    "FetchPostResult",
+    "GetConnectionSessionParams",
+    "GetLimitsParams",
+    "GetLimitsUsageParams",
+    "LanguageProficiency",
+    "Limit",
+    "LimitCategory",
+    "LimitParams",
+    "LimitPeriod",
+    "LimitSinceParams",
+    "LimitUsage",
+    "LimitUsageResult",
+    "LimitsResult",
+    "LinkedApiActionError",
+    "LinkedApiModel",
+    "LinkedApiRequestError",
+    "LinkedApiResponse",
+    "LocationType",
+    "MaxAnnualRevenue",
+    "Message",
+    "MessageSender",
+    "MinAnnualRevenue",
+    "NvBaseFetchCompanyParams",
+    "NvBaseFetchCompanyParamsWide",
+    "NvCompany",
+    "NvCompanyDm",
+    "NvCompanyEmployee",
+    "NvCompanyEmployeeFilter",
+    "NvCompanyEmployeeRetrievalConfig",
+    "NvFetchCompanyParams",
+    "NvFetchCompanyResult",
+    "NvOpenPersonPageParams",
+    "NvOpenPersonPageResult",
+    "NvSearchCompaniesFilter",
+    "NvSearchCompaniesParams",
+    "NvSearchCompanyResult",
+    "NvSearchPeopleFilter",
+    "NvSearchPeopleParams",
+    "NvSearchPeopleResult",
+    "NvSendMessageParams",
+    "NvSyncConversationParams",
+    "PendingConnectionSession",
+    "Person",
+    "PersonEducation",
+    "PersonExperience",
+    "PersonLanguage",
+    "PersonSkill",
+    "Post",
+    "PostComment",
+    "PostCommenterType",
+    "PostCommentsRetrievalConfig",
+    "PostCommentsSort",
+    "PostEngagerType",
+    "PostReaction",
+    "PostReactionsRetrievalConfig",
+    "PostType",
+    "ReactToPostParams",
+    "Reaction",
+    "ReactionType",
+    "RegenerateTokenParams",
+    "RegenerateTokenResult",
+    "RemoveConnectionParams",
+    "ResetLimitsParams",
+    "RetrieveConnectionsFilter",
+    "RetrieveConnectionsParams",
+    "RetrieveConnectionsResult",
+    "RetrievePendingRequestsResult",
+    "RetrievePerformanceResult",
+    "RetrieveSSIResult",
+    "SearchCompaniesFilter",
+    "SearchCompaniesParams",
+    "SearchCompanyResult",
+    "SearchCompanySize",
+    "SearchPeopleFilter",
+    "SearchPeopleParams",
+    "SearchPeopleResult",
+    "SeatType",
+    "SendConnectionRequestParams",
+    "SendMessageParams",
+    "SetLimitEntry",
+    "SetLimitsParams",
+    "SetSeatsParams",
+    "SetSeatsResult",
+    "SetSeatsStatus",
+    "StCompanyDm",
+    "StCompanyEmployee",
+    "StCompanyEmployeesFilter",
+    "StCompanyEmployeesRetrievalConfig",
+    "SubscriptionPricingResult",
+    "SubscriptionProduct",
+    "SubscriptionSeat",
+    "SubscriptionSeatsResult",
+    "SubscriptionStatus",
+    "SubscriptionStatusValue",
+    "SyncConversationParams",
+    "WithdrawConnectionRequestParams",
+    "WorkflowCancelResponse",
+    "WorkflowCompletion",
+    "WorkflowCompletionSingleAction",
+    "WorkflowDefinition",
+    "WorkflowFailure",
+    "WorkflowInProgressResponse",
+    "WorkflowInProgressStatus",
+    "WorkflowResponse",
+    "WorkflowStartedResponse",
+    "WorkflowStatus",
+    "YearsOfExperience",
+    "dump_model_by_name",
+    "serialize_model",
+    "serialize_value",
+]

linkedapi/types/account.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from linkedapi.types.base import LinkedApiModel
+
+
+class AccountInfo(LinkedApiModel):
+    name: str | None = None
+    url: str | None = None

linkedapi/types/admin/__init__.py

@@ -0,0 +1,91 @@
+from linkedapi.types.admin.accounts import (
+    AccountsResult,
+    AdminAccount,
+    AdminAccountStatus,
+    CancelConnectionSessionParams,
+    ConnectionSession,
+    ConnectionSessionResult,
+    ConnectionSessionStatus,
+    CreateConnectionSessionResult,
+    DisconnectParams,
+    GetConnectionSessionParams,
+    PendingConnectionSession,
+    RegenerateTokenParams,
+    RegenerateTokenResult,
+)
+from linkedapi.types.admin.config import AdminConfig
+from linkedapi.types.admin.limits import (
+    DeleteLimitEntry,
+    DeleteLimitsParams,
+    GetLimitsParams,
+    GetLimitsUsageParams,
+    Limit,
+    LimitCategory,
+    LimitPeriod,
+    LimitsResult,
+    LimitUsage,
+    LimitUsageResult,
+    ResetLimitsParams,
+    SetLimitEntry,
+    SetLimitsParams,
+)
+from linkedapi.types.admin.subscription import (
+    BillingLinkResult,
+    BillingPeriod,
+    CancelResult,
+    Currency,
+    SeatType,
+    SetSeatsParams,
+    SetSeatsResult,
+    SetSeatsStatus,
+    SubscriptionPricingResult,
+    SubscriptionProduct,
+    SubscriptionSeat,
+    SubscriptionSeatsResult,
+    SubscriptionStatus,
+    SubscriptionStatusValue,
+)
+
+__all__ = [
+    "AccountsResult",
+    "AdminAccount",
+    "AdminAccountStatus",
+    "AdminConfig",
+    "BillingLinkResult",
+    "BillingPeriod",
+    "CancelConnectionSessionParams",
+    "CancelResult",
+    "ConnectionSession",
+    "ConnectionSessionResult",
+    "ConnectionSessionStatus",
+    "CreateConnectionSessionResult",
+    "Currency",
+    "DeleteLimitEntry",
+    "DeleteLimitsParams",
+    "DisconnectParams",
+    "GetConnectionSessionParams",
+    "GetLimitsParams",
+    "GetLimitsUsageParams",
+    "Limit",
+    "LimitCategory",
+    "LimitPeriod",
+    "LimitUsage",
+    "LimitUsageResult",
+    "LimitsResult",
+    "PendingConnectionSession",
+    "RegenerateTokenParams",
+    "RegenerateTokenResult",
+    "ResetLimitsParams",
+    "SeatType",
+    "SetLimitEntry",
+    "SetLimitsParams",
+    "SetSeatsParams",
+    "SetSeatsResult",
+    "SetSeatsStatus",
+    "SubscriptionPricingResult",
+    "SubscriptionProduct",
+    "SubscriptionSeat",
+    "SubscriptionSeatsResult",
+    "SubscriptionStatus",
+    "SubscriptionStatusValue",
+]

linkedapi/types/admin/accounts.py

@@ -0,0 +1,71 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from linkedapi.types.base import LinkedApiModel
+
+AdminAccountStatus = Literal["active", "frozen", "reconnection_required"]
+ConnectionSessionStatus = Literal[
+    "pending",
+    "preparing",
+    "serving",
+    "streaming",
+    "success",
+    "expired",
+    "error",
+    "cancelled",
+]
+
+
+class AdminAccount(LinkedApiModel):
+    id: str | None = None
+    name: str | None = None
+    country_code: str | None = None
+    identification_token: str | None = None
+    status: AdminAccountStatus | None = None
+    connected_at: str | None = None
+
+
+class PendingConnectionSession(LinkedApiModel):
+    session_id: str | None = None
+    status: str | None = None
+
+
+class AccountsResult(LinkedApiModel):
+    accounts: list[AdminAccount] | None = None
+    pending_connection_sessions: list[PendingConnectionSession] | None = None
+
+
+class DisconnectParams(LinkedApiModel):
+    account_id: str
+
+
+class RegenerateTokenParams(LinkedApiModel):
+    account_id: str
+
+
+class RegenerateTokenResult(LinkedApiModel):
+    token: str | None = None
+
+
+class CreateConnectionSessionResult(LinkedApiModel):
+    session_id: str | None = None
+    connection_link: str | None = None
+
+
+class GetConnectionSessionParams(LinkedApiModel):
+    session_id: str
+
+
+class ConnectionSession(LinkedApiModel):
+    session_id: str | None = None
+    status: ConnectionSessionStatus | None = None
+    type: str | None = None
+
+
+class ConnectionSessionResult(LinkedApiModel):
+    session: ConnectionSession | None = None
+
+
+class CancelConnectionSessionParams(LinkedApiModel):
+    session_id: str

linkedapi/types/admin/config.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from linkedapi.types.base import LinkedApiModel
+
+
+class AdminConfig(LinkedApiModel):
+    linked_api_token: str
+    client: str = "python"

linkedapi/types/admin/limits.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from linkedapi.types.base import LinkedApiModel
+
+LimitCategory = Literal[
+    "stPersonProfileViews",
+    "stCompanyPageViews",
+    "stConnectionRequests",
+    "stMessages",
+    "stSearchQueries",
+    "stReactions",
+    "stComments",
+    "stPosts",
+    "nvPersonProfileViews",
+    "nvCompanyPageViews",
+    "nvMessages",
+]
+LimitPeriod = Literal["daily", "weekly", "monthly"]
+
+
+class Limit(LinkedApiModel):
+    category: LimitCategory | None = None
+    period: LimitPeriod | None = None
+    max_value: int | None = None
+    is_enabled: bool | None = None
+
+
+class LimitUsage(LinkedApiModel):
+    category: LimitCategory | None = None
+    period: LimitPeriod | None = None
+    max_value: int | None = None
+    current_usage: int | None = None
+    is_enabled: bool | None = None
+
+
+class GetLimitsParams(LinkedApiModel):
+    account_id: str
+
+
+class GetLimitsUsageParams(LinkedApiModel):
+    account_id: str
+
+
+class SetLimitEntry(LinkedApiModel):
+    category: LimitCategory
+    period: LimitPeriod
+    max_value: int
+    is_enabled: bool | None = None
+
+
+class SetLimitsParams(LinkedApiModel):
+    account_id: str
+    limits: list[SetLimitEntry]
+
+
+class DeleteLimitEntry(LinkedApiModel):
+    category: LimitCategory
+    period: LimitPeriod
+
+
+class DeleteLimitsParams(LinkedApiModel):
+    account_id: str
+    limits: list[DeleteLimitEntry]
+
+
+class ResetLimitsParams(LinkedApiModel):
+    account_id: str
+
+
+class LimitsResult(LinkedApiModel):
+    limits: list[Limit] | None = None
+
+
+class LimitUsageResult(LinkedApiModel):
+    usage: list[LimitUsage] | None = None