getanyapi 0.1.0__py3-none-any.whl

getanyapi/platforms/substack.py

@@ -0,0 +1,142 @@
+# Generated - do not edit. Regenerate with: pnpm generate
+"""Generated namespace module for the substack platform."""
+
+from __future__ import annotations
+
+from typing import Literal, TYPE_CHECKING
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import NotRequired, Required, TypedDict, Unpack
+
+from ..types import RequestOptions, RunResult
+
+if TYPE_CHECKING:
+    from .._async_client import AsyncAnyAPI
+    from .._client import AnyAPI
+
+
+class SubstackPostsInput(TypedDict, total=False):
+    """Input for Substack Posts."""
+
+    contentType: NotRequired[Literal["all", "newsletter", "podcast", "thread"]]
+    """Restrict to a single post type, or 'all' (e.g. newsletter). Default: all."""
+    includeContent: NotRequired[bool]
+    """Include the full article body as HTML. Set false for metadata only (e.g. false). Default: true."""
+    limit: NotRequired[int]
+    """Maximum number of recent posts to return when given a publication URL (1-100, default 25); ignored for a single post URL, which always returns that one post. You are billed per post returned, so a lower limit costs less. Range: 1 to 100."""
+    onlyFree: NotRequired[bool]
+    """Return only free (non-paywalled) posts (e.g. true). Default: false."""
+    url: Required[str]
+    """Either a Substack publication URL / custom domain to fetch its recent posts (e.g. https://www.astralcodexten.com), OR a single post URL to fetch just that one article with full content (e.g. https://www.astralcodexten.com/p/your-book-review)."""
+
+
+class SubstackPostsData(BaseModel):
+    items: list[SubstackPostsItem] = Field(
+        description="Post records: title, subtitle, URL, publish date, paywall status, word count, engagement (reactions, comments, restacks), author profile, publication info, and full article HTML when requested."
+    )
+
+
+class SubstackPostsItem(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    author_handle: str | None = Field(
+        default=None,
+        alias="authorHandle",
+        description="Present whenever the upstream returns this record.",
+    )
+    author_name: str | None = Field(
+        default=None,
+        alias="authorName",
+        description="Present whenever the upstream returns this record.",
+    )
+    comment_count: int | None = Field(default=None, alias="commentCount")
+    description: str | None = Field(
+        default=None, description="Present whenever the upstream returns this record."
+    )
+    image: str | None = Field(
+        default=None,
+        description="Cover image URL. Present whenever the upstream returns this record.",
+    )
+    is_paid: bool | None = Field(default=None, alias="isPaid")
+    post_id: str | None = Field(
+        default=None,
+        alias="postId",
+        description="Present whenever the upstream returns this record.",
+    )
+    post_type: str | None = Field(
+        default=None,
+        alias="postType",
+        description="Present whenever the upstream returns this record.",
+    )
+    published_at: str | None = Field(
+        default=None,
+        alias="publishedAt",
+        description="ISO 8601 publish date. Present whenever the upstream returns this record.",
+    )
+    reaction_count: int | None = Field(default=None, alias="reactionCount")
+    subtitle: str | None = Field(
+        default=None, description="Present whenever the upstream returns this record."
+    )
+    title: str
+    url: str
+    wordcount: int | None = None
+
+
+class SubstackNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AnyAPI") -> None:
+        self._client = client
+
+    def posts(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[SubstackPostsInput],
+    ) -> RunResult[SubstackPostsData]:
+        """Substack Posts
+
+        Pull posts from any Substack publication by its URL - or pass a single post
+        URL (…/p/slug) to fetch just that one article. Returns title, subtitle,
+        publish date, paywall status, word count, engagement (reactions, comments,
+        restacks), author profile, and full article HTML. Priced per post returned.
+
+        Price: $0.005 per request plus $0.00156 per result.
+
+        Example:
+            res = client.substack.posts(limit=3, url="https://www.astralcodexten.com")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "substack.posts", dict(input), options
+        )
+        return RunResult[SubstackPostsData].model_validate(raw)
+
+
+class AsyncSubstackNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AsyncAnyAPI") -> None:
+        self._client = client
+
+    async def posts(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[SubstackPostsInput],
+    ) -> RunResult[SubstackPostsData]:
+        """Substack Posts
+
+        Pull posts from any Substack publication by its URL - or pass a single post
+        URL (…/p/slug) to fetch just that one article. Returns title, subtitle,
+        publish date, paywall status, word count, engagement (reactions, comments,
+        restacks), author profile, and full article HTML. Priced per post returned.
+
+        Price: $0.005 per request plus $0.00156 per result.
+
+        Example:
+            res = client.substack.posts(limit=3, url="https://www.astralcodexten.com")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "substack.posts", dict(input), options
+        )
+        return RunResult[SubstackPostsData].model_validate(raw)

getanyapi/platforms/threads.py

@@ -0,0 +1,358 @@
+# Generated - do not edit. Regenerate with: pnpm generate
+"""Generated namespace module for the threads platform."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Required, TypedDict, Unpack
+
+from ..types import RequestOptions, RunResult
+
+if TYPE_CHECKING:
+    from .._async_client import AsyncAnyAPI
+    from .._client import AnyAPI
+
+
+class ThreadsPostInput(TypedDict, total=False):
+    """Input for Threads Post."""
+
+    url: Required[str]
+    """The full URL of the Threads post to fetch (e.g. https://www.threads.com/@zuck/post/C8yKXdRxKqK)."""
+
+
+class ThreadsProfileInput(TypedDict, total=False):
+    """Input for Threads Profile."""
+
+    username: Required[str]
+    """The Threads username to look up, without the @ prefix (e.g. zuck)."""
+
+
+class ThreadsSearchInput(TypedDict, total=False):
+    """Input for Threads Search."""
+
+    query: Required[str]
+    """Keyword or hashtag to search public Threads posts for; the # prefix is optional (e.g. AI agents)."""
+
+
+class ThreadsSearchUsersInput(TypedDict, total=False):
+    """Input for Threads User Search."""
+
+    query: Required[str]
+    """The name or username to search Threads users for."""
+
+
+class ThreadsUserPostsInput(TypedDict, total=False):
+    """Input for Threads User Posts."""
+
+    handle: Required[str]
+    """The Threads username to list posts for, without the @ prefix."""
+
+
+class ThreadsPostData(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    code: str
+    full_name: str = Field(alias="fullName")
+    id: str
+    like_count: int = Field(alias="likeCount")
+    quote_count: int = Field(alias="quoteCount")
+    reply_count: int = Field(alias="replyCount")
+    repost_count: int = Field(alias="repostCount")
+    taken_at: int = Field(alias="takenAt")
+    text: str
+    username: str
+
+
+class ThreadsProfileData(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    biography: str
+    follower_count: int = Field(alias="followerCount")
+    full_name: str = Field(alias="fullName")
+    id: str
+    is_private: bool = Field(alias="isPrivate")
+    is_verified: bool = Field(alias="isVerified")
+    profile_pic_url: str = Field(alias="profilePicUrl")
+    username: str
+
+
+class ThreadsSearchData(BaseModel):
+    posts: list[ThreadsSearchPost] = Field(
+        description="Matching public post records: text, author, engagement counts, timestamp, and URL."
+    )
+
+
+class ThreadsSearchPost(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    code: str
+    full_name: str = Field(alias="fullName")
+    id: str
+    like_count: int = Field(alias="likeCount")
+    reply_count: int = Field(alias="replyCount")
+    repost_count: int = Field(alias="repostCount")
+    taken_at: int = Field(alias="takenAt")
+    text: str
+    url: str
+    username: str
+
+
+class ThreadsSearchUsersData(BaseModel):
+    users: list[ThreadsSearchUsersUser]
+
+
+class ThreadsSearchUsersUser(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    full_name: str = Field(alias="fullName")
+    id: str
+    is_verified: bool = Field(alias="isVerified")
+    profile_pic_url: str = Field(alias="profilePicUrl")
+    username: str
+
+
+class ThreadsUserPostsData(BaseModel):
+    posts: list[ThreadsUserPostsPost]
+
+
+class ThreadsUserPostsPost(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    code: str
+    id: str
+    like_count: int = Field(alias="likeCount")
+    quote_count: int = Field(alias="quoteCount")
+    reply_count: int = Field(alias="replyCount")
+    repost_count: int = Field(alias="repostCount")
+    taken_at: int = Field(alias="takenAt")
+    text: str
+    url: str
+    username: str
+
+
+class ThreadsNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AnyAPI") -> None:
+        self._client = client
+
+    def post(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsPostInput],
+    ) -> RunResult[ThreadsPostData]:
+        """Threads Post
+
+        Fetch a single Threads post by URL - text, author, engagement counts, and
+        timestamp - billed per request in USD.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.post(url="https://www.threads.com/@aaronparnas/post/DZxPYVFkYSq")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.post", dict(input), options
+        )
+        return RunResult[ThreadsPostData].model_validate(raw)
+
+    def profile(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsProfileInput],
+    ) -> RunResult[ThreadsProfileData]:
+        """Threads Profile
+
+        Fetch a Threads user's public profile (bio, follower count, verification,
+        profile picture) by username, billed per request in USD.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.profile(username="zuck")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.profile", dict(input), options
+        )
+        return RunResult[ThreadsProfileData].model_validate(raw)
+
+    def search(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsSearchInput],
+    ) -> RunResult[ThreadsSearchData]:
+        """Threads Search
+
+        Search public Threads posts by keyword or hashtag and get normalized post
+        records - text, author, and engagement - billed per request in USD.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.search(query="trump")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.search", dict(input), options
+        )
+        return RunResult[ThreadsSearchData].model_validate(raw)
+
+    def search_users(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsSearchUsersInput],
+    ) -> RunResult[ThreadsSearchUsersData]:
+        """Threads User Search
+
+        Search Threads users by name or username and get normalized profile records
+        - username, full name, verification, and picture - at a flat per-request USD
+        price.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.search_users(query="shams")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.search_users", dict(input), options
+        )
+        return RunResult[ThreadsSearchUsersData].model_validate(raw)
+
+    def user_posts(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsUserPostsInput],
+    ) -> RunResult[ThreadsUserPostsData]:
+        """Threads User Posts
+
+        List a Threads user's recent public posts by username - text, engagement
+        counts, and post URLs - at a flat per-request USD price.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.user_posts(handle="trendspider")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.user_posts", dict(input), options
+        )
+        return RunResult[ThreadsUserPostsData].model_validate(raw)
+
+
+class AsyncThreadsNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AsyncAnyAPI") -> None:
+        self._client = client
+
+    async def post(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsPostInput],
+    ) -> RunResult[ThreadsPostData]:
+        """Threads Post
+
+        Fetch a single Threads post by URL - text, author, engagement counts, and
+        timestamp - billed per request in USD.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.post(url="https://www.threads.com/@aaronparnas/post/DZxPYVFkYSq")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.post", dict(input), options
+        )
+        return RunResult[ThreadsPostData].model_validate(raw)
+
+    async def profile(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsProfileInput],
+    ) -> RunResult[ThreadsProfileData]:
+        """Threads Profile
+
+        Fetch a Threads user's public profile (bio, follower count, verification,
+        profile picture) by username, billed per request in USD.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.profile(username="zuck")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.profile", dict(input), options
+        )
+        return RunResult[ThreadsProfileData].model_validate(raw)
+
+    async def search(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsSearchInput],
+    ) -> RunResult[ThreadsSearchData]:
+        """Threads Search
+
+        Search public Threads posts by keyword or hashtag and get normalized post
+        records - text, author, and engagement - billed per request in USD.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.search(query="trump")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.search", dict(input), options
+        )
+        return RunResult[ThreadsSearchData].model_validate(raw)
+
+    async def search_users(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsSearchUsersInput],
+    ) -> RunResult[ThreadsSearchUsersData]:
+        """Threads User Search
+
+        Search Threads users by name or username and get normalized profile records
+        - username, full name, verification, and picture - at a flat per-request USD
+        price.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.search_users(query="shams")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.search_users", dict(input), options
+        )
+        return RunResult[ThreadsSearchUsersData].model_validate(raw)
+
+    async def user_posts(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[ThreadsUserPostsInput],
+    ) -> RunResult[ThreadsUserPostsData]:
+        """Threads User Posts
+
+        List a Threads user's recent public posts by username - text, engagement
+        counts, and post URLs - at a flat per-request USD price.
+
+        Price: $0.002 per request.
+
+        Example:
+            res = client.threads.user_posts(handle="trendspider")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "threads.user_posts", dict(input), options
+        )
+        return RunResult[ThreadsUserPostsData].model_validate(raw)