xdataapi 0.3.1__tar.gz → 0.3.2__tar.gz

{xdataapi-0.3.1 → xdataapi-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xdataapi
-Version: 0.3.1
+Version: 0.3.2
 Summary: Python client for the xdataapi.io API: read-only X (Twitter) profiles, tweets, threads, search.
 License: MIT
 Keywords: twitter,x,api,tweets,sdk,xdataapi,twitter-api,x-api,mcp,agent,llm

{xdataapi-0.3.1 → xdataapi-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "xdataapi"
-version = "0.3.1"
+version = "0.3.2"
 description = "Python client for the xdataapi.io API: read-only X (Twitter) profiles, tweets, threads, search."
 authors = []
 license = "MIT"

xdataapi-0.3.2/xdataapi/api/users/get_user_by_id.py

@@ -0,0 +1,222 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error import Error
+from ...models.user_response import UserResponse
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    id: str,
+    *,
+    fresh: bool | Unset = False,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    params["fresh"] = fresh
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/users/id/{id}".format(
+            id=quote(str(id), safe=""),
+        ),
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Error | UserResponse | None:
+    if response.status_code == 200:
+        response_200 = UserResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 400:
+        response_400 = Error.from_dict(response.json())
+
+        return response_400
+
+    if response.status_code == 401:
+        response_401 = Error.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 402:
+        response_402 = Error.from_dict(response.json())
+
+        return response_402
+
+    if response.status_code == 404:
+        response_404 = Error.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 429:
+        response_429 = Error.from_dict(response.json())
+
+        return response_429
+
+    if response.status_code == 500:
+        response_500 = Error.from_dict(response.json())
+
+        return response_500
+
+    if response.status_code == 503:
+        response_503 = Error.from_dict(response.json())
+
+        return response_503
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Error | UserResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    fresh: bool | Unset = False,
+) -> Response[Error | UserResponse]:
+    """Profile by user id
+
+     The same profile as `/v1/users/{handle}`, found by the numeric user id. The id stays the same when a
+    user changes the handle, so it is the key to store. 1 credit per profile.
+
+    Args:
+        id (str):
+        fresh (bool | Unset):  Default: False.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Error | UserResponse]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        fresh=fresh,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    fresh: bool | Unset = False,
+) -> Error | UserResponse | None:
+    """Profile by user id
+
+     The same profile as `/v1/users/{handle}`, found by the numeric user id. The id stays the same when a
+    user changes the handle, so it is the key to store. 1 credit per profile.
+
+    Args:
+        id (str):
+        fresh (bool | Unset):  Default: False.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Error | UserResponse
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        fresh=fresh,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    fresh: bool | Unset = False,
+) -> Response[Error | UserResponse]:
+    """Profile by user id
+
+     The same profile as `/v1/users/{handle}`, found by the numeric user id. The id stays the same when a
+    user changes the handle, so it is the key to store. 1 credit per profile.
+
+    Args:
+        id (str):
+        fresh (bool | Unset):  Default: False.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Error | UserResponse]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        fresh=fresh,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    fresh: bool | Unset = False,
+) -> Error | UserResponse | None:
+    """Profile by user id
+
+     The same profile as `/v1/users/{handle}`, found by the numeric user id. The id stays the same when a
+    user changes the handle, so it is the key to store. 1 credit per profile.
+
+    Args:
+        id (str):
+        fresh (bool | Unset):  Default: False.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Error | UserResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            fresh=fresh,
+        )
+    ).parsed

{xdataapi-0.3.1 → xdataapi-0.3.2}/xdataapi/api/users/get_users.py

@@ -95,17 +95,20 @@ def sync_detailed(
     body: GetUsersBody,
     fresh: bool | Unset = False,
 ) -> Response[Error | UserBatch]:
-    """Profiles by handle, batch
-
-     Up to 100 profiles in one call. 1 credit per profile found; handles that do not exist are listed in
-    `errors` and cost nothing. Duplicates are folded. Results in input order. Also `GET
-    /v1/users/batch?handles=a,b,c`.
+    """Profiles by handle or by user id, batch
+
+     Up to 100 profiles in one call, by handle (`handles`) or by numeric user id (`ids`). Send one of the
+    two
+    lists. The id stays the same when a user changes the handle. 1 credit per profile found; inputs that
+    do
+    not exist are listed in `errors` and cost nothing. Duplicates are folded. Results in input order.
+    Also `GET /v1/users/batch?handles=a,b,c` and `GET /v1/users/batch?ids=783214,13334762`.
     When the balance covers only part of the list, the tail comes back as `no_credits` and is not
     fetched.
 
     Args:
         fresh (bool | Unset):  Default: False.
-        body (GetUsersBody):
+        body (GetUsersBody): Exactly one of `handles` and `ids`.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -133,17 +136,20 @@ def sync(
     body: GetUsersBody,
     fresh: bool | Unset = False,
 ) -> Error | UserBatch | None:
-    """Profiles by handle, batch
-
-     Up to 100 profiles in one call. 1 credit per profile found; handles that do not exist are listed in
-    `errors` and cost nothing. Duplicates are folded. Results in input order. Also `GET
-    /v1/users/batch?handles=a,b,c`.
+    """Profiles by handle or by user id, batch
+
+     Up to 100 profiles in one call, by handle (`handles`) or by numeric user id (`ids`). Send one of the
+    two
+    lists. The id stays the same when a user changes the handle. 1 credit per profile found; inputs that
+    do
+    not exist are listed in `errors` and cost nothing. Duplicates are folded. Results in input order.
+    Also `GET /v1/users/batch?handles=a,b,c` and `GET /v1/users/batch?ids=783214,13334762`.
     When the balance covers only part of the list, the tail comes back as `no_credits` and is not
     fetched.
 
     Args:
         fresh (bool | Unset):  Default: False.
-        body (GetUsersBody):
+        body (GetUsersBody): Exactly one of `handles` and `ids`.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -166,17 +172,20 @@ async def asyncio_detailed(
     body: GetUsersBody,
     fresh: bool | Unset = False,
 ) -> Response[Error | UserBatch]:
-    """Profiles by handle, batch
-
-     Up to 100 profiles in one call. 1 credit per profile found; handles that do not exist are listed in
-    `errors` and cost nothing. Duplicates are folded. Results in input order. Also `GET
-    /v1/users/batch?handles=a,b,c`.
+    """Profiles by handle or by user id, batch
+
+     Up to 100 profiles in one call, by handle (`handles`) or by numeric user id (`ids`). Send one of the
+    two
+    lists. The id stays the same when a user changes the handle. 1 credit per profile found; inputs that
+    do
+    not exist are listed in `errors` and cost nothing. Duplicates are folded. Results in input order.
+    Also `GET /v1/users/batch?handles=a,b,c` and `GET /v1/users/batch?ids=783214,13334762`.
     When the balance covers only part of the list, the tail comes back as `no_credits` and is not
     fetched.
 
     Args:
         fresh (bool | Unset):  Default: False.
-        body (GetUsersBody):
+        body (GetUsersBody): Exactly one of `handles` and `ids`.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -202,17 +211,20 @@ async def asyncio(
     body: GetUsersBody,
     fresh: bool | Unset = False,
 ) -> Error | UserBatch | None:
-    """Profiles by handle, batch
-
-     Up to 100 profiles in one call. 1 credit per profile found; handles that do not exist are listed in
-    `errors` and cost nothing. Duplicates are folded. Results in input order. Also `GET
-    /v1/users/batch?handles=a,b,c`.
+    """Profiles by handle or by user id, batch
+
+     Up to 100 profiles in one call, by handle (`handles`) or by numeric user id (`ids`). Send one of the
+    two
+    lists. The id stays the same when a user changes the handle. 1 credit per profile found; inputs that
+    do
+    not exist are listed in `errors` and cost nothing. Duplicates are folded. Results in input order.
+    Also `GET /v1/users/batch?handles=a,b,c` and `GET /v1/users/batch?ids=783214,13334762`.
     When the balance covers only part of the list, the tail comes back as `no_credits` and is not
     fetched.
 
     Args:
         fresh (bool | Unset):  Default: False.
-        body (GetUsersBody):
+        body (GetUsersBody): Exactly one of `handles` and `ids`.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

{xdataapi-0.3.1 → xdataapi-0.3.2}/xdataapi/models/error_body.py

@@ -7,6 +7,7 @@ from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
 from ..models.error_body_code import ErrorBodyCode
+from ..types import UNSET, Unset
 
 T = TypeVar("T", bound="ErrorBody")
 
@@ -18,10 +19,13 @@ class ErrorBody:
     Attributes:
         code (ErrorBodyCode):
         message (str):
+        top_up_url (str | Unset): Only on `no_credits`. The page where a pack is bought. Example:
+            https://xdataapi.io/dashboard/billing.
     """
 
     code: ErrorBodyCode
     message: str
+    top_up_url: str | Unset = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
@@ -29,6 +33,8 @@ class ErrorBody:
 
         message = self.message
 
+        top_up_url = self.top_up_url
+
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update(
@@ -37,6 +43,8 @@ class ErrorBody:
                 "message": message,
             }
         )
+        if top_up_url is not UNSET:
+            field_dict["top_up_url"] = top_up_url
 
         return field_dict
 
@@ -47,9 +55,12 @@ class ErrorBody:
 
         message = d.pop("message")
 
+        top_up_url = d.pop("top_up_url", UNSET)
+
         error_body = cls(
             code=code,
             message=message,
+            top_up_url=top_up_url,
         )
 
         error_body.additional_properties = d

{xdataapi-0.3.1 → xdataapi-0.3.2}/xdataapi/models/error_body_code.py

@@ -5,6 +5,7 @@ class ErrorBodyCode(StrEnum):
     ACCESS_DENIED = "access_denied"
     BAD_REQUEST = "bad_request"
     BILLING_DISABLED = "billing_disabled"
+    EMAIL_NOT_ALLOWED = "email_not_allowed"
     INTERNAL = "internal"
     INVALID_KEY = "invalid_key"
     MISSING_KEY = "missing_key"

{xdataapi-0.3.1 → xdataapi-0.3.2}/xdataapi/models/get_users_body.py

@@ -6,39 +6,53 @@ from typing import Any, TypeVar, cast
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
+from ..types import UNSET, Unset
+
 T = TypeVar("T", bound="GetUsersBody")
 
 
 @_attrs_define
 class GetUsersBody:
-    """
+    """Exactly one of `handles` and `ids`.
+
     Attributes:
-        handles (list[str]):  Example: ['x', 'github', 'vercel'].
+        handles (list[str] | Unset):  Example: ['x', 'github', 'vercel'].
+        ids (list[str] | Unset):  Example: ['783214', '13334762'].
     """
 
-    handles: list[str]
+    handles: list[str] | Unset = UNSET
+    ids: list[str] | Unset = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
-        handles = self.handles
+        handles: list[str] | Unset = UNSET
+        if not isinstance(self.handles, Unset):
+            handles = self.handles
+
+        ids: list[str] | Unset = UNSET
+        if not isinstance(self.ids, Unset):
+            ids = self.ids
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "handles": handles,
-            }
-        )
+        field_dict.update({})
+        if handles is not UNSET:
+            field_dict["handles"] = handles
+        if ids is not UNSET:
+            field_dict["ids"] = ids
 
         return field_dict
 
     @classmethod
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
         d = dict(src_dict)
-        handles = cast(list[str], d.pop("handles"))
+        handles = cast(list[str], d.pop("handles", UNSET))
+
+        ids = cast(list[str], d.pop("ids", UNSET))
 
         get_users_body = cls(
             handles=handles,
+            ids=ids,
         )
 
         get_users_body.additional_properties = d

{xdataapi-0.3.1 → xdataapi-0.3.2}/xdataapi/models/list_packs_response_200.py

@@ -57,9 +57,7 @@ class ListPacksResponse200:
     @classmethod
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
         from ..models.list_packs_response_200_data_item import ListPacksResponse200DataItem  # noqa: PLC0415
-        from ..models.list_packs_response_200_rate_limits_item import (
-            ListPacksResponse200RateLimitsItem,  # noqa: PLC0415
-        )
+        from ..models.list_packs_response_200_rate_limits_item import ListPacksResponse200RateLimitsItem  # noqa: PLC0415
 
         d = dict(src_dict)
         _data = d.pop("data", UNSET)