linkedapi 1.0.0__py3-none-any.whl

linkedapi/types/admin/subscription.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from linkedapi.types.base import LinkedApiModel
+
+SubscriptionStatusValue = Literal["active", "trialing", "past_due", "canceled"]
+SeatType = Literal["core", "plus"]
+BillingPeriod = Literal["month", "year"]
+Currency = Literal["usd", "eur"]
+SetSeatsStatus = Literal["complete", "processing"]
+
+
+class SubscriptionStatus(LinkedApiModel):
+    status: SubscriptionStatusValue | None = None
+    eligible_for_trial: bool | None = None
+    cancel_at_period_end: bool | None = None
+
+
+class SubscriptionSeat(LinkedApiModel):
+    seat_type: SeatType | None = None
+    quantity: int | None = None
+    billing_period: BillingPeriod | None = None
+
+
+class SubscriptionProduct(LinkedApiModel):
+    id: str | None = None
+    seat_type: SeatType | None = None
+    billing_period: BillingPeriod | None = None
+    unit_price: int | None = None
+    currency: Currency | None = None
+
+
+class SetSeatsParams(LinkedApiModel):
+    quantity: int
+    seat_type: SeatType
+    billing_period: BillingPeriod
+
+
+class SetSeatsResult(LinkedApiModel):
+    status: SetSeatsStatus | None = None
+    payment_link: str | None = None
+
+
+class BillingLinkResult(LinkedApiModel):
+    stripe_link: str | None = None
+
+
+class CancelResult(LinkedApiModel):
+    cancel_at_date: str | None = None
+
+
+class SubscriptionSeatsResult(LinkedApiModel):
+    seats: list[SubscriptionSeat] | None = None
+
+
+class SubscriptionPricingResult(LinkedApiModel):
+    products: list[SubscriptionProduct] | None = None

linkedapi/types/base.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict
+
+
+def to_camel(value: str) -> str:
+    parts = value.split("_")
+    return parts[0] + "".join(part.capitalize() for part in parts[1:])
+
+
+class LinkedApiModel(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+
+
+def serialize_value(value: Any) -> Any:
+    if isinstance(value, BaseModel):
+        return value.model_dump(by_alias=True, exclude_none=True)
+    if isinstance(value, list):
+        return [serialize_value(item) for item in value]
+    if isinstance(value, tuple):
+        return [serialize_value(item) for item in value]
+    if isinstance(value, dict):
+        return {key: serialize_value(item) for key, item in value.items() if item is not None}
+    return value
+
+
+def serialize_model(value: Any) -> dict[str, Any]:
+    serialized = serialize_value(value)
+    if serialized is None:
+        return {}
+    if isinstance(serialized, dict):
+        return serialized
+    msg = "Expected object-like parameters"
+    raise TypeError(msg)
+
+
+def dump_model_by_name(value: Any) -> dict[str, Any]:
+    if value is None:
+        return {}
+    if isinstance(value, BaseModel):
+        return value.model_dump(by_alias=False, exclude_none=True)
+    if isinstance(value, dict):
+        return {str(key): item for key, item in value.items() if item is not None}
+    msg = "Expected object-like parameters"
+    raise TypeError(msg)

linkedapi/types/company.py

@@ -0,0 +1,140 @@
+from __future__ import annotations
+
+from typing import Literal, TypeAlias
+
+from pydantic import Field
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams, LimitParams, LimitSinceParams
+from linkedapi.types.person import YearsOfExperience
+from linkedapi.types.post import Post
+
+
+class StCompanyEmployee(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    headline: str | None = None
+    location: str | None = None
+
+
+class StCompanyDm(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    headline: str | None = None
+    location: str | None = None
+    country_code: str | None = None
+
+
+class Company(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    description: str | None = None
+    location: str | None = None
+    headquarters: str | None = None
+    industry: str | None = None
+    specialties: str | None = None
+    website: str | None = None
+    employees_count: int | None = None
+    year_founded: int | None = None
+    venture_financing: bool | None = None
+    jobs_count: int | None = None
+    employees: list[StCompanyEmployee] | None = None
+    dms: list[StCompanyDm] | None = None
+    posts: list[Post] | None = None
+
+
+class BaseFetchCompanyParams(BaseActionParams):
+    company_url: str
+    retrieve_employees: bool | None = None
+    retrieve_dms: bool | None = Field(default=None, alias="retrieveDMs")
+    retrieve_posts: bool | None = None
+
+
+class BaseFetchCompanyParamsWide(BaseFetchCompanyParams):
+    retrieve_employees: Literal[True] = True
+    retrieve_dms: Literal[True] = Field(default=True, alias="retrieveDMs")
+    retrieve_posts: Literal[True] = True
+
+
+class StCompanyEmployeesFilter(LinkedApiModel):
+    first_name: str | None = None
+    last_name: str | None = None
+    position: str | None = None
+    locations: list[str] | None = None
+    industries: list[str] | None = None
+    schools: list[str] | None = None
+
+
+class StCompanyEmployeesRetrievalConfig(LimitParams):
+    filter: StCompanyEmployeesFilter | None = None
+
+
+class FetchCompanyParams(BaseFetchCompanyParams):
+    employees_retrieval_config: StCompanyEmployeesRetrievalConfig | None = None
+    dms_retrieval_config: LimitParams | None = Field(default=None, alias="dmsRetrievalConfig")
+    posts_retrieval_config: LimitSinceParams | None = None
+
+
+FetchCompanyResult: TypeAlias = Company
+
+
+class NvCompanyEmployee(LinkedApiModel):
+    name: str | None = None
+    hashed_url: str | None = None
+    position: str | None = None
+    location: str | None = None
+
+
+class NvCompanyDm(LinkedApiModel):
+    name: str | None = None
+    hashed_url: str | None = None
+    position: str | None = None
+    location: str | None = None
+    country_code: str | None = None
+
+
+class NvCompany(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    description: str | None = None
+    location: str | None = None
+    headquarters: str | None = None
+    industry: str | None = None
+    website: str | None = None
+    employees_count: int | None = None
+    year_founded: int | None = None
+    employees: list[NvCompanyEmployee] | None = None
+    dms: list[NvCompanyDm] | None = None
+
+
+class NvBaseFetchCompanyParams(BaseActionParams):
+    company_hashed_url: str
+    retrieve_employees: bool | None = None
+    retrieve_dms: bool | None = Field(default=None, alias="retrieveDMs")
+
+
+class NvBaseFetchCompanyParamsWide(NvBaseFetchCompanyParams):
+    retrieve_employees: Literal[True] = True
+    retrieve_dms: Literal[True] = Field(default=True, alias="retrieveDMs")
+
+
+class NvCompanyEmployeeFilter(LinkedApiModel):
+    first_name: str | None = None
+    last_name: str | None = None
+    positions: list[str] | None = None
+    locations: list[str] | None = None
+    industries: list[str] | None = None
+    schools: list[str] | None = None
+    years_of_experiences: list[YearsOfExperience] | None = None
+
+
+class NvCompanyEmployeeRetrievalConfig(LimitParams):
+    filter: NvCompanyEmployeeFilter | None = None
+
+
+class NvFetchCompanyParams(NvBaseFetchCompanyParams):
+    employees_retrieval_config: NvCompanyEmployeeRetrievalConfig | None = None
+    dms_retrieval_config: LimitParams | None = Field(default=None, alias="dmsRetrievalConfig")
+
+
+NvFetchCompanyResult: TypeAlias = NvCompany

linkedapi/types/connection.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams, LimitParams
+
+ConnectionStatus = Literal["connected", "pending", "notConnected"]
+
+
+class ConnectionPerson(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    headline: str | None = None
+    location: str | None = None
+    profile_image_url: str | None = None
+
+
+class SendConnectionRequestParams(BaseActionParams):
+    person_url: str
+    note: str | None = None
+    email: str | None = None
+
+
+class CheckConnectionStatusParams(BaseActionParams):
+    person_url: str
+
+
+class CheckConnectionStatusResult(LinkedApiModel):
+    connection_status: ConnectionStatus | None = None
+
+
+class WithdrawConnectionRequestParams(BaseActionParams):
+    person_url: str
+    unfollow: bool | None = None
+
+
+class RetrievePendingRequestsResult(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    headline: str | None = None
+    sent_time: str | None = None
+
+
+class RetrieveConnectionsFilter(LinkedApiModel):
+    first_name: str | None = None
+    last_name: str | None = None
+    position: str | None = None
+    locations: list[str] | None = None
+    industries: list[str] | None = None
+    current_companies: list[str] | None = None
+    previous_companies: list[str] | None = None
+    schools: list[str] | None = None
+
+
+class RetrieveConnectionsParams(LimitParams):
+    since: str | None = None
+    filter: RetrieveConnectionsFilter | None = None
+
+
+class RetrieveConnectionsResult(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    headline: str | None = None
+    location: str | None = None
+    connected_at: str | None = None
+
+
+class RemoveConnectionParams(BaseActionParams):
+    person_url: str
+
+
+class NvOpenPersonPageParams(BaseActionParams):
+    person_hashed_url: str
+
+
+class NvOpenPersonPageResult(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    hashed_url: str | None = None
+    headline: str | None = None
+    location: str | None = None
+    country_code: str | None = None
+    position: str | None = None
+    company_name: str | None = None
+    company_hashed_url: str | None = None

linkedapi/types/message.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams
+
+ConversationType = Literal["st", "nv"]
+MessageSender = Literal["us", "them"]
+
+
+class SendMessageParams(BaseActionParams):
+    person_url: str
+    text: str
+
+
+class SyncConversationParams(BaseActionParams):
+    person_url: str
+
+
+class NvSendMessageParams(BaseActionParams):
+    person_url: str
+    text: str
+    subject: str
+
+
+class NvSyncConversationParams(BaseActionParams):
+    person_url: str
+
+
+class ConversationPollRequest(LinkedApiModel):
+    person_url: str
+    type: ConversationType
+    since: str | None = None
+
+
+class Message(LinkedApiModel):
+    id: str | None = None
+    sender: MessageSender | None = None
+    text: str | None = None
+    time: str | None = None
+
+
+class ConversationPollResult(LinkedApiModel):
+    person_url: str | None = None
+    type: ConversationType | None = None
+    messages: list[Message] | None = None
+    since: str | None = None

linkedapi/types/params.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from linkedapi.types.base import LinkedApiModel
+
+
+class BaseActionParams(LinkedApiModel):
+    pass
+
+
+class LimitParams(LinkedApiModel):
+    limit: int | None = None
+
+
+class LimitSinceParams(LimitParams):
+    since: str | None = None

linkedapi/types/person.py

@@ -0,0 +1,105 @@
+from __future__ import annotations
+
+from typing import Literal, TypeAlias
+
+from linkedapi.types.params import BaseActionParams, LimitSinceParams
+from linkedapi.types.post import Comment, Post, Reaction
+
+EmploymentType = Literal[
+    "fullTime",
+    "partTime",
+    "selfEmployed",
+    "freelance",
+    "contract",
+    "internship",
+    "apprenticeship",
+    "seasonal",
+]
+LocationType = Literal["onSite", "remote", "hybrid"]
+LanguageProficiency = Literal[
+    "elementary",
+    "limitedWorking",
+    "professionalWorking",
+    "fullProfessional",
+    "nativeOrBilingual",
+]
+YearsOfExperience = Literal["lessThanOne", "oneToTwo", "threeToFive", "sixToTen", "moreThanTen"]
+
+
+class BaseFetchPersonParams(BaseActionParams):
+    person_url: str
+    retrieve_experience: bool | None = None
+    retrieve_education: bool | None = None
+    retrieve_skills: bool | None = None
+    retrieve_languages: bool | None = None
+    retrieve_posts: bool | None = None
+    retrieve_comments: bool | None = None
+    retrieve_reactions: bool | None = None
+
+
+class BaseFetchPersonParamsWide(BaseFetchPersonParams):
+    retrieve_experience: Literal[True] = True
+    retrieve_education: Literal[True] = True
+    retrieve_skills: Literal[True] = True
+    retrieve_languages: Literal[True] = True
+    retrieve_posts: Literal[True] = True
+    retrieve_comments: Literal[True] = True
+    retrieve_reactions: Literal[True] = True
+
+
+class FetchPersonParams(BaseFetchPersonParams):
+    posts_retrieval_config: LimitSinceParams | None = None
+    comments_retrieval_config: LimitSinceParams | None = None
+    reactions_retrieval_config: LimitSinceParams | None = None
+
+
+class PersonExperience(BaseActionParams):
+    position: str | None = None
+    company_name: str | None = None
+    company_hashed_url: str | None = None
+    employment_type: EmploymentType | None = None
+    location_type: LocationType | None = None
+    description: str | None = None
+    duration: int | None = None
+    start_time: str | None = None
+    end_time: str | None = None
+    location: str | None = None
+
+
+class PersonEducation(BaseActionParams):
+    school_name: str | None = None
+    school_hashed_url: str | None = None
+    details: str | None = None
+
+
+class PersonSkill(BaseActionParams):
+    name: str | None = None
+
+
+class PersonLanguage(BaseActionParams):
+    name: str | None = None
+    proficiency: LanguageProficiency | None = None
+
+
+class Person(BaseActionParams):
+    name: str | None = None
+    public_url: str | None = None
+    hashed_url: str | None = None
+    headline: str | None = None
+    location: str | None = None
+    country_code: str | None = None
+    position: str | None = None
+    company_name: str | None = None
+    company_hashed_url: str | None = None
+    followers_count: int | None = None
+    about: str | None = None
+    experiences: list[PersonExperience] | None = None
+    education: list[PersonEducation] | None = None
+    skills: list[PersonSkill] | None = None
+    languages: list[PersonLanguage] | None = None
+    posts: list[Post] | None = None
+    comments: list[Comment] | None = None
+    reactions: list[Reaction] | None = None
+
+
+FetchPersonResult: TypeAlias = Person

linkedapi/types/post.py

@@ -0,0 +1,119 @@
+from __future__ import annotations
+
+from typing import Literal, TypeAlias
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams, LimitParams
+
+PostType = Literal["original", "repost"]
+ReactionType = Literal["like", "celebrate", "support", "love", "insightful", "funny"]
+PostCommenterType = Literal["person", "company"]
+PostEngagerType = Literal["person", "company"]
+PostCommentsSort = Literal["mostRelevant", "mostRecent"]
+AttachmentType = Literal["image", "video", "document"]
+
+
+class Reaction(LinkedApiModel):
+    post_url: str | None = None
+    time: str | None = None
+    reaction_type: ReactionType | None = None
+
+
+class Comment(LinkedApiModel):
+    post_url: str | None = None
+    time: str | None = None
+    text: str | None = None
+    image: str | None = None
+    reactions_count: int | None = None
+
+
+class ReactToPostParams(BaseActionParams):
+    post_url: str
+    type: ReactionType
+    company_url: str | None = None
+
+
+class CommentOnPostParams(BaseActionParams):
+    post_url: str
+    text: str
+    company_url: str | None = None
+
+
+class PostComment(LinkedApiModel):
+    commenter_url: str | None = None
+    commenter_name: str | None = None
+    commenter_headline: str | None = None
+    commenter_type: PostCommenterType | None = None
+    time: str | None = None
+    text: str | None = None
+    image: str | None = None
+    is_reply: bool | None = None
+    reactions_count: int | None = None
+    replies_count: int | None = None
+
+
+class PostReaction(LinkedApiModel):
+    engager_url: str | None = None
+    engager_name: str | None = None
+    engager_headline: str | None = None
+    engager_type: PostEngagerType | None = None
+    type: ReactionType | None = None
+
+
+class Post(LinkedApiModel):
+    url: str | None = None
+    time: str | None = None
+    type: PostType | None = None
+    repost_text: str | None = None
+    text: str | None = None
+    images: list[str] | None = None
+    has_video: bool | None = None
+    has_poll: bool | None = None
+    reactions_count: int | None = None
+    comments_count: int | None = None
+    reposts_count: int | None = None
+    comments: list[PostComment] | None = None
+    reactions: list[PostReaction] | None = None
+
+
+class PostCommentsRetrievalConfig(LimitParams):
+    replies: bool | None = None
+    sort: PostCommentsSort | None = None
+
+
+PostReactionsRetrievalConfig: TypeAlias = LimitParams
+
+
+class BaseFetchPostParams(BaseActionParams):
+    post_url: str
+    retrieve_comments: bool | None = None
+    retrieve_reactions: bool | None = None
+
+
+class BaseFetchPostParamsWide(BaseFetchPostParams):
+    retrieve_comments: Literal[True] = True
+    retrieve_reactions: Literal[True] = True
+
+
+class FetchPostParams(BaseFetchPostParams):
+    comments_retrieval_config: PostCommentsRetrievalConfig | None = None
+    reactions_retrieval_config: PostReactionsRetrievalConfig | None = None
+
+
+FetchPostResult: TypeAlias = Post
+
+
+class CreatePostAttachment(LinkedApiModel):
+    url: str
+    type: AttachmentType
+    name: str | None = None
+
+
+class CreatePostParams(BaseActionParams):
+    text: str
+    attachments: list[CreatePostAttachment] | None = None
+    company_url: str | None = None
+
+
+class CreatePostResult(LinkedApiModel):
+    post_url: str | None = None

linkedapi/types/responses.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from typing import Generic, TypeVar
+
+from linkedapi.types.base import LinkedApiModel
+
+TResult = TypeVar("TResult")
+
+
+class LinkedApiRequestError(LinkedApiModel):
+    type: str
+    message: str
+
+
+class LinkedApiResponse(LinkedApiModel, Generic[TResult]):
+    success: bool
+    result: TResult | None = None
+    error: LinkedApiRequestError | None = None