linkedapi 1.0.0__py3-none-any.whl

linkedapi/types/search_companies.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from typing import Literal
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams, LimitParams
+
+SearchCompanySize = Literal[
+    "1-10",
+    "11-50",
+    "51-200",
+    "201-500",
+    "501-1000",
+    "1001-5000",
+    "5001-10000",
+    "10001+",
+]
+MinAnnualRevenue = Literal["0", "0.5", "1", "2.5", "5", "10", "20", "50", "100", "500", "1000"]
+MaxAnnualRevenue = Literal[
+    "0.5",
+    "1",
+    "2.5",
+    "5",
+    "10",
+    "20",
+    "50",
+    "100",
+    "500",
+    "1000",
+    "1000+",
+]
+
+
+class SearchCompaniesFilter(LinkedApiModel):
+    sizes: list[SearchCompanySize] | None = None
+    locations: list[str] | None = None
+    industries: list[str] | None = None
+
+
+class SearchCompaniesParams(BaseActionParams, LimitParams):
+    term: str | None = None
+    filter: SearchCompaniesFilter | None = None
+    custom_search_url: str | None = None
+
+
+class SearchCompanyResult(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    industry: str | None = None
+    location: str | None = None
+
+
+class AnnualRevenueFilter(LinkedApiModel):
+    min: MinAnnualRevenue
+    max: MaxAnnualRevenue
+
+
+class NvSearchCompaniesFilter(SearchCompaniesFilter):
+    annual_revenue: AnnualRevenueFilter | None = None
+
+
+class NvSearchCompaniesParams(BaseActionParams, LimitParams):
+    term: str | None = None
+    filter: NvSearchCompaniesFilter | None = None
+    custom_search_url: str | None = None
+
+
+class NvSearchCompanyResult(LinkedApiModel):
+    name: str | None = None
+    hashed_url: str | None = None
+    industry: str | None = None
+    employees_count: int | None = None

linkedapi/types/search_people.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+from linkedapi.types.base import LinkedApiModel
+from linkedapi.types.params import BaseActionParams, LimitParams
+from linkedapi.types.person import YearsOfExperience
+
+
+class SearchPeopleFilter(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 SearchPeopleParams(BaseActionParams, LimitParams):
+    term: str | None = None
+    filter: SearchPeopleFilter | None = None
+    custom_search_url: str | None = None
+
+
+class SearchPeopleResult(LinkedApiModel):
+    name: str | None = None
+    public_url: str | None = None
+    headline: str | None = None
+    location: str | None = None
+
+
+class NvSearchPeopleFilter(SearchPeopleFilter):
+    years_of_experience: list[YearsOfExperience] | None = None
+
+
+class NvSearchPeopleParams(BaseActionParams, LimitParams):
+    term: str | None = None
+    filter: NvSearchPeopleFilter | None = None
+    custom_search_url: str | None = None
+
+
+class NvSearchPeopleResult(LinkedApiModel):
+    name: str | None = None
+    hashed_url: str | None = None
+    position: str | None = None
+    location: str | None = None

linkedapi/types/statistics.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from linkedapi.types.base import LinkedApiModel
+
+
+class RetrieveSSIResult(LinkedApiModel):
+    ssi: int | None = None
+    industry_top: int | None = None
+    network_top: int | None = None
+
+
+class RetrievePerformanceResult(LinkedApiModel):
+    followers_count: int | None = None
+    post_views_last_7_days: int | None = None
+    profile_views_last_90_days: int | None = None
+    search_appearances_previous_week: int | None = None
+
+
+class ApiUsageParams(LinkedApiModel):
+    start: str
+    end: str
+
+
+class ApiUsageAction(LinkedApiModel):
+    action_type: str | None = None
+    success: bool | None = None
+    time: str | None = None

linkedapi/types/workflow.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from typing import Any, Literal
+
+from linkedapi.errors import LinkedApiActionErrorType
+from linkedapi.types.base import LinkedApiModel
+
+WorkflowPendingStatus = Literal["pending"]
+WorkflowRunningStatus = Literal["running"]
+WorkflowInProgressStatus = Literal["pending", "running"]
+WorkflowStatus = Literal["pending", "running", "completed", "failed"]
+WorkflowDefinition = dict[str, Any] | list[dict[str, Any]]
+WorkflowCompletion = dict[str, Any] | list[dict[str, Any]]
+
+
+class LinkedApiActionError(LinkedApiModel):
+    type: LinkedApiActionErrorType | str
+    message: str
+
+
+class WorkflowStartedResponse(LinkedApiModel):
+    workflow_id: str
+    workflow_status: WorkflowInProgressStatus
+    message: str | None = None
+
+
+class WorkflowInProgressResponse(LinkedApiModel):
+    workflow_id: str
+    workflow_status: WorkflowInProgressStatus
+    message: str | None = None
+
+
+class WorkflowFailure(LinkedApiModel):
+    reason: str
+    message: str
+
+
+class WorkflowCancelResponse(LinkedApiModel):
+    cancelled: bool
+
+
+class WorkflowResponse(LinkedApiModel):
+    workflow_id: str
+    workflow_status: WorkflowStatus
+    message: str | None = None
+    completion: WorkflowCompletion | None = None
+    failure: WorkflowFailure | None = None
+
+
+class WorkflowCompletionSingleAction(LinkedApiModel):
+    action_type: str
+    success: bool
+    data: Any | None = None
+    error: LinkedApiActionError | None = None
+    label: str | None = None

linkedapi-1.0.0.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: linkedapi
+Version: 1.0.0
+Summary: Official synchronous Python SDK for Linked API.
+Project-URL: Homepage, https://linkedapi.io
+Project-URL: Repository, https://github.com/Linked-API/linkedapi-python
+Project-URL: Documentation, https://linkedapi.io/docs/
+Author: Linked API
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,automation,data,linkedapi,linkedin,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: requests<3,>=2
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: requests-mock>=1.12; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Description-Content-Type: text/markdown
+
+This official Python SDK is the synchronous way to integrate with Linked API. It provides pre-defined workflow operations, direct account/statistics methods, admin APIs, authentication headers, polling, and structured error responses.
+
+## Get started
+
+To get started with Linked API Python SDK, read these essential guides first:
+
+1. [Core concepts](https://linkedapi.io/sdks/core-concepts-0/) - understand how Linked API works.
+2. [Installation & authorization](https://linkedapi.io/sdks/installation-authorization/) - install the SDK and authorize it.
+3. [Predefined vs. custom workflows](https://linkedapi.io/sdks/predefined-vs-custom-workflows/) - choose ready-made operations or custom workflow definitions.
+4. [Handling results and errors](https://linkedapi.io/sdks/handling-results-and-errors/) - process successful data and action errors.
+5. [Persisting and cancelling workflows](https://linkedapi.io/sdks/persisting-and-cancelling-workflows/) - save, resume, and cancel workflows.
+
+Install the package:
+
+```bash
+pip install linkedapi
+```
+
+Initialize the client:
+
+```python
+from linkedapi import LinkedApi, LinkedApiConfig
+
+linkedapi = LinkedApi(
+    LinkedApiConfig(
+        linked_api_token="your-linked-api-token",
+        identification_token="your-identification-token",
+    )
+)
+```
+
+Run a predefined workflow and poll the result:
+
+```python
+from linkedapi import FetchPersonParams
+
+workflow = linkedapi.fetch_person.execute(
+    FetchPersonParams(
+        person_url="https://www.linkedin.com/in/john-doe",
+        retrieve_experience=True,
+        retrieve_posts=True,
+        posts_retrieval_config={"limit": 10},
+    )
+)
+
+result = linkedapi.fetch_person.result(workflow.workflow_id)
+if result.data:
+    print(result.data.name)
+for error in result.errors:
+    print(error.type, error.message)
+```
+
+Execute a custom workflow:
+
+```python
+workflow = linkedapi.custom_workflow.execute(
+    {
+        "actionType": "st.searchCompanies",
+        "term": "Tech Inc",
+        "filter": {
+            "sizes": ["51-200", "2001-5000"],
+            "locations": ["San Francisco", "New York"],
+            "industries": ["Software Development"],
+        },
+        "then": {"actionType": "st.openCompanyPage", "basicInfo": True},
+    }
+)
+
+result = linkedapi.custom_workflow.result(workflow.workflow_id)
+print(result.data)
+```
+
+Continue polling after a workflow timeout:
+
+```python
+from linkedapi import LinkedApiWorkflowTimeoutError
+
+try:
+    result = linkedapi.fetch_person.result(workflow.workflow_id, timeout=30.0)
+except LinkedApiWorkflowTimeoutError as error:
+    result = linkedapi.fetch_person.result(error.workflow_id)
+```
+
+Cancel a workflow:
+
+```python
+cancelled = linkedapi.fetch_person.cancel(workflow.workflow_id)
+print(cancelled)
+```
+
+## License
+
+This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.

linkedapi-1.0.0.dist-info/RECORD

@@ -0,0 +1,72 @@
+linkedapi/__init__.py,sha256=zhpfl31KfPq-k-RAM5ikJnWs-Q7_zRlXsnop2NbtvH4,2979
+linkedapi/client.py,sha256=Rke8tfNG8hebCxn1hD-xA8ZKFOtcmCtr2at4jQzdb4M,6490
+linkedapi/config.py,sha256=Nc46xV3WiSXj5OuEw2IJyO-XPv06guRMWMzVzbe-u3Q,255
+linkedapi/errors.py,sha256=90INoaJl1xkjD4r2v5b3v3tOdVePgbO5koS2c0ttKoY,3119
+linkedapi/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+linkedapi/admin/__init__.py,sha256=2Z-s2bTr_PhYSLCmnGWef6zbtYEuaNKvgIlMCi9nRKk,387
+linkedapi/admin/accounts.py,sha256=9vaflLumW-gs6Ia425LKP6b3_cP86n5Dgl-p7RmvG4w,2992
+linkedapi/admin/admin.py,sha256=2I1sHtiGjMXkPJw6Za20hJCW7oy5FYQNMHbOBJDeS_o,821
+linkedapi/admin/http_client.py,sha256=Ee0eSMAdEBcPz-L1KT5s0aanjeBi45boZSj-nYtkteA,2579
+linkedapi/admin/limits.py,sha256=52ialCK31Vxo8HofktxhH6ChjnN8MiIWJ_0WDxBfwow,2428
+linkedapi/admin/subscription.py,sha256=7dPmUly5v3ULvGq7zQ60KwbK4-iWVIPNbvjOkafj3qY,2231
+linkedapi/core/__init__.py,sha256=68f8fG9wQIIEFNBM4DwL_LSKmWDrmy2Td6WmdyAQQ0Q,152
+linkedapi/core/operation.py,sha256=1N_84a7Ef3LPyLWYWDFLRYwplJvma4Zvw03bFF24YzY,3550
+linkedapi/core/polling.py,sha256=Xz3ERfNUmlB9hlRYu35S9nWS21K1pDoM8bJHaEWDz9I,1511
+linkedapi/http/__init__.py,sha256=NfTLhzkBOtrGuwdJtI0Cdzxby2VjfunsB_YTI6senXk,162
+linkedapi/http/base.py,sha256=6NFt2unHdRotclFM45F5w-3TJh1V4qKv6WcMWyifPio,604
+linkedapi/http/linked_api_http_client.py,sha256=YZ5M1DqxH7F4zDQtpoaEhLpDQbW39l99Lk1vxA92ZNA,2662
+linkedapi/mappers/__init__.py,sha256=6jk0FIYTXz3ECg0FL8YpODM9-YTKtr6ff2-cWja-2DM,520
+linkedapi/mappers/array.py,sha256=XGs9S70cYTnGzwRuHRebQi4e2a4rqlfCHbuhZ7bK4bU,1798
+linkedapi/mappers/base.py,sha256=_Vtu-ZbzCxEyeXi4qEFNc7usJLP3Mn7695B-0aHuVcs,2142
+linkedapi/mappers/simple.py,sha256=kThK_o6txXw9ofDFpxnwJQvaFX217NIpA2S4bwoWW54,1926
+linkedapi/mappers/then.py,sha256=75QDoLfMeqB9ZVDS1ZUhcixnP2VMAqaQC2lxdWk3g2A,6134
+linkedapi/mappers/void.py,sha256=y1IagCGAih3NWYLwyfSAeq6N56ZEo9TiYXP9RWXZWuU,1157
+linkedapi/operations/__init__.py,sha256=WSzrSty0xTBQ91V_2Sy5BWbC3rdY5IARKsc76PxJ6Aw,2489
+linkedapi/operations/check_connection_status.py,sha256=HUOc65DQInW4eKKIfIUZT3f5h5TKJ4kzIrmURgsvt2o,595
+linkedapi/operations/comment_on_post.py,sha256=jUyF000FcWZGanoMcn6PWnvl_JxAoHTfc2WSWivibKM,380
+linkedapi/operations/create_post.py,sha256=KrzOo1qKEGdju00yO9UZnH3VZHSOtiIFYwR6Mq9UusY,464
+linkedapi/operations/custom_workflow.py,sha256=ccuG-P-4bkk5SdDittL4tz8xMCaU4sscE9FfQ4VzhOU,805
+linkedapi/operations/fetch_company.py,sha256=w-ySUiBGFCO3wSa9ml1pNzndldrQ8F7mSKkGxHl_xr0,1360
+linkedapi/operations/fetch_person.py,sha256=NfUKHa9FlnVXStZolj38cUaU7b4zwAf4R91aX92-vTQ,1991
+linkedapi/operations/fetch_post.py,sha256=iNd2Mutpskrcmp5rbF9Nb7dY_RhOF_Je5OLHlTKZMFA,1143
+linkedapi/operations/nv_fetch_company.py,sha256=5wqRE0yufov_gVEr1WLubNroD2HQ66EZtV7F7bn2ad0,1210
+linkedapi/operations/nv_fetch_person.py,sha256=ygW2a65ldu2CjVEbtGRx73DWckvs4FLtE4PMBqbNaOg,779
+linkedapi/operations/nv_search_companies.py,sha256=EIkHNdwKWjEJVPdwCn_N6XEYHDS3lTA5VxCRSlXnuj8,528
+linkedapi/operations/nv_search_people.py,sha256=fbQLJBWAFZEdmR19bAhIQ4EsX1Zl34CkCyyTZwMI7ao,503
+linkedapi/operations/nv_send_message.py,sha256=rmCa5W-3bNiky1dVd1SIlkZowU9TLUuXw4DO3IM0PDM,382
+linkedapi/operations/nv_sync_conversation.py,sha256=z058Y5Y1IZPYkTRUByh1zSA9XjnOcjpCtsnedbuyi6M,417
+linkedapi/operations/react_to_post.py,sha256=8HWtH-B85fXFzYtmR-Mh1sFsn8HadjXMdNk34lUVZk8,366
+linkedapi/operations/remove_connection.py,sha256=u7MKaBvt0XHs6Eq59EaI4S4McrYvWJaPtPXosOaoEeY,409
+linkedapi/operations/retrieve_connections.py,sha256=DBVaWpcBLeyM_mOTM0u5iK_NJrx6W_09gvUWkr0EiWQ,561
+linkedapi/operations/retrieve_pending_requests.py,sha256=DF0aFodvpSDcFXOT1miR2v_GwV2_0niVGUKVjBxj888,536
+linkedapi/operations/retrieve_performance.py,sha256=xOxvHDwAT09NvTzBAlrKime0pERTumvehqrdfvsUgRw,500
+linkedapi/operations/retrieve_ssi.py,sha256=zhJ35vwU8wXQjfbENzoA3epbAn5sI0Kyw9Mv2obN7UA,436
+linkedapi/operations/search_companies.py,sha256=gwJFtdWdaxCi-yBLGeKpNiCuVjs4ZTW8aFK3fM7hYTE,512
+linkedapi/operations/search_people.py,sha256=JmaBc7GNGqQYhvgF0raTcXmljbmU7s7rql1hknsscWE,487
+linkedapi/operations/send_connection_request.py,sha256=eF4kqQ6-sOGtVT06wjdq-hShRwnkXZ3B0DEKSM6v1Fw,445
+linkedapi/operations/send_message.py,sha256=w0-hNHlN2bU5FqDDGWwWy0yGfCSztpZt2hEqTUl-4UY,374
+linkedapi/operations/sync_conversation.py,sha256=2yeAe72XnHx38DXk8MOefy2q1132xpbrLBhTzxAeITQ,409
+linkedapi/operations/withdraw_connection_request.py,sha256=S_5zdqge_Wy_w1RoVpwcB7aIvf5o4bnqLdLWsUt78No,481
+linkedapi/types/__init__.py,sha256=TeT8VPB_LB3FUgXJcot7IacEPLc9bl4lPhQbtYC-wHI,8406
+linkedapi/types/account.py,sha256=L7_bBIml5OYAC7HB77IZrVsCJYJ2vyfX1mSG3ryqKsg,176
+linkedapi/types/base.py,sha256=Ftvkikhtj97xhNs9uz2pypcOM9td0DrzcuOEVujdu9A,1474
+linkedapi/types/company.py,sha256=XfqzX9ib-JPreEXspyzpEV9LXRPtIDvHOhQ62niYOsk,4313
+linkedapi/types/connection.py,sha256=S2VGH74ATwgBjtP0uhbb__XtVPnZwNneaQwHZsERbp0,2266
+linkedapi/types/message.py,sha256=NUdJjXpuUGLOUDd9CinczZ1sGINqTWmWTMNB_7_1OWc,1035
+linkedapi/types/params.py,sha256=L9Rvp03mqYrU6gJ-avfPcRqrAv7c4DKFv2q07qsAr6E,269
+linkedapi/types/person.py,sha256=CSAOaOR_1yVRDBNmd3vO44A44cHLvs3adg5zy33XHH4,3156
+linkedapi/types/post.py,sha256=7yl9BEhXW6ra4oKBu8PNqGqsYqmp8a6Xe7Gv3YiPNhM,3253
+linkedapi/types/responses.py,sha256=sS29ouKNdS8EEiHb-_rmMc4Bads5aOPWKOxi4pR0RII,389
+linkedapi/types/search_companies.py,sha256=nr7aElNVS5eCpMN6qzi4z-Qq9cc2rCyASL2rjyEpuD0,1666
+linkedapi/types/search_people.py,sha256=eraF74N9Be1Oo2WNh0EwmkJXFmIvwijh26JxQonSCLY,1361
+linkedapi/types/statistics.py,sha256=ZIdWn8ql_mYbxQc-UAk3mb3HZapjP4wQ0ugfDJ7pVGI,670
+linkedapi/types/workflow.py,sha256=a0gQ3rm1ujLGbSZPPL_lZbwHxDhhPjCoN-fQCamM24E,1466
+linkedapi/types/admin/__init__.py,sha256=4wPh4qjjDm5p8xoZ57_am4Jz5Z7xcV2RwRVg9I2kQzc,2146
+linkedapi/types/admin/accounts.py,sha256=vcYLtGkueYdMjjhnBQQj5qX_-lfczE4TXK9QZ4Wl9mg,1609
+linkedapi/types/admin/config.py,sha256=N2KI-zQcA6zQ6fQLNytygqfZ3V71pF1H5e8J3785FIA,174
+linkedapi/types/admin/limits.py,sha256=6kJgpgVqpgVB6BrkVJX-wXuUDYS1TJa4YOW28gXs8es,1620
+linkedapi/types/admin/subscription.py,sha256=bhaXUgTXT9vdPqKd-WKgjXv65C1wpItLaAmgVtE7XUU,1512
+linkedapi-1.0.0.dist-info/METADATA,sha256=SWfqgILMRHVwoXzj0Wvo50UZLOT9aD8xyTuwYLX4sac,4057
+linkedapi-1.0.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+linkedapi-1.0.0.dist-info/licenses/LICENSE,sha256=4r5LcqzbcInGycbODbnbf5i_ZJN_zOkKV81ebcZ6VC4,1090
+linkedapi-1.0.0.dist-info/RECORD,,

linkedapi-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

linkedapi-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Linked API <https://linkedapi.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.