jsonhub-sdk 0.9.1__py3-none-any.whl

jsonhub_sdk/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing JsonHub API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

jsonhub_sdk/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

jsonhub_sdk/api/definition/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

jsonhub_sdk/api/definition/api_definitions_get_collection.py

@@ -0,0 +1,246 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_definitions_get_collection_response_200 import ApiDefinitionsGetCollectionResponse200
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    qid: Union[Unset, str] = UNSET,
+    owned: Union[Unset, bool] = UNSET,
+    page: Union[Unset, int] = 1,
+    limit: Union[Unset, int] = 10,
+    properties: Union[Unset, list[str]] = UNSET,
+    parent_entity: Union[Unset, str] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["qid"] = qid
+
+    params["owned"] = owned
+
+    params["page"] = page
+
+    params["limit"] = limit
+
+    json_properties: Union[Unset, list[str]] = UNSET
+    if not isinstance(properties, Unset):
+        json_properties = properties
+
+    params["properties[]"] = json_properties
+
+    params["parentEntity"] = parent_entity
+
+    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": "/api/definitions",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[ApiDefinitionsGetCollectionResponse200]:
+    if response.status_code == 200:
+        response_200 = ApiDefinitionsGetCollectionResponse200.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[ApiDefinitionsGetCollectionResponse200]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    qid: Union[Unset, str] = UNSET,
+    owned: Union[Unset, bool] = UNSET,
+    page: Union[Unset, int] = 1,
+    limit: Union[Unset, int] = 10,
+    properties: Union[Unset, list[str]] = UNSET,
+    parent_entity: Union[Unset, str] = UNSET,
+) -> Response[ApiDefinitionsGetCollectionResponse200]:
+    """Retrieves the collection of definition resources.
+
+     Retrieves the collection of definition resources.
+
+    Args:
+        qid (Union[Unset, str]):
+        owned (Union[Unset, bool]):
+        page (Union[Unset, int]):  Default: 1.
+        limit (Union[Unset, int]):  Default: 10.
+        properties (Union[Unset, list[str]]):
+        parent_entity (Union[Unset, str]):
+
+    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[ApiDefinitionsGetCollectionResponse200]
+    """
+
+    kwargs = _get_kwargs(
+        qid=qid,
+        owned=owned,
+        page=page,
+        limit=limit,
+        properties=properties,
+        parent_entity=parent_entity,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    qid: Union[Unset, str] = UNSET,
+    owned: Union[Unset, bool] = UNSET,
+    page: Union[Unset, int] = 1,
+    limit: Union[Unset, int] = 10,
+    properties: Union[Unset, list[str]] = UNSET,
+    parent_entity: Union[Unset, str] = UNSET,
+) -> Optional[ApiDefinitionsGetCollectionResponse200]:
+    """Retrieves the collection of definition resources.
+
+     Retrieves the collection of definition resources.
+
+    Args:
+        qid (Union[Unset, str]):
+        owned (Union[Unset, bool]):
+        page (Union[Unset, int]):  Default: 1.
+        limit (Union[Unset, int]):  Default: 10.
+        properties (Union[Unset, list[str]]):
+        parent_entity (Union[Unset, str]):
+
+    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:
+        ApiDefinitionsGetCollectionResponse200
+    """
+
+    return sync_detailed(
+        client=client,
+        qid=qid,
+        owned=owned,
+        page=page,
+        limit=limit,
+        properties=properties,
+        parent_entity=parent_entity,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    qid: Union[Unset, str] = UNSET,
+    owned: Union[Unset, bool] = UNSET,
+    page: Union[Unset, int] = 1,
+    limit: Union[Unset, int] = 10,
+    properties: Union[Unset, list[str]] = UNSET,
+    parent_entity: Union[Unset, str] = UNSET,
+) -> Response[ApiDefinitionsGetCollectionResponse200]:
+    """Retrieves the collection of definition resources.
+
+     Retrieves the collection of definition resources.
+
+    Args:
+        qid (Union[Unset, str]):
+        owned (Union[Unset, bool]):
+        page (Union[Unset, int]):  Default: 1.
+        limit (Union[Unset, int]):  Default: 10.
+        properties (Union[Unset, list[str]]):
+        parent_entity (Union[Unset, str]):
+
+    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[ApiDefinitionsGetCollectionResponse200]
+    """
+
+    kwargs = _get_kwargs(
+        qid=qid,
+        owned=owned,
+        page=page,
+        limit=limit,
+        properties=properties,
+        parent_entity=parent_entity,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    qid: Union[Unset, str] = UNSET,
+    owned: Union[Unset, bool] = UNSET,
+    page: Union[Unset, int] = 1,
+    limit: Union[Unset, int] = 10,
+    properties: Union[Unset, list[str]] = UNSET,
+    parent_entity: Union[Unset, str] = UNSET,
+) -> Optional[ApiDefinitionsGetCollectionResponse200]:
+    """Retrieves the collection of definition resources.
+
+     Retrieves the collection of definition resources.
+
+    Args:
+        qid (Union[Unset, str]):
+        owned (Union[Unset, bool]):
+        page (Union[Unset, int]):  Default: 1.
+        limit (Union[Unset, int]):  Default: 10.
+        properties (Union[Unset, list[str]]):
+        parent_entity (Union[Unset, str]):
+
+    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:
+        ApiDefinitionsGetCollectionResponse200
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            qid=qid,
+            owned=owned,
+            page=page,
+            limit=limit,
+            properties=properties,
+            parent_entity=parent_entity,
+        )
+    ).parsed

jsonhub_sdk/api/definition/api_definitions_id_delete.py

@@ -0,0 +1,168 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error import Error
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": f"/api/definitions/{id}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, Error]]:
+    if response.status_code == 204:
+        response_204 = cast(Any, None)
+        return response_204
+
+    if response.status_code == 403:
+        response_403 = Error.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 404:
+        response_404 = Error.from_dict(response.json())
+
+        return response_404
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Any, Error]]:
+    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: Union[AuthenticatedClient, Client],
+) -> Response[Union[Any, Error]]:
+    """Removes the definition resource.
+
+     Removes the definition resource.
+
+    Args:
+        id (str):
+
+    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[Union[Any, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[Any, Error]]:
+    """Removes the definition resource.
+
+     Removes the definition resource.
+
+    Args:
+        id (str):
+
+    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:
+        Union[Any, Error]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[Any, Error]]:
+    """Removes the definition resource.
+
+     Removes the definition resource.
+
+    Args:
+        id (str):
+
+    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[Union[Any, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[Any, Error]]:
+    """Removes the definition resource.
+
+     Removes the definition resource.
+
+    Args:
+        id (str):
+
+    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:
+        Union[Any, Error]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed

jsonhub_sdk/api/definition/api_definitions_id_get.py

@@ -0,0 +1,165 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.definition_jsonhal_definition_read import DefinitionJsonhalDefinitionRead
+from ...models.error import Error
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/api/definitions/{id}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[DefinitionJsonhalDefinitionRead, Error]]:
+    if response.status_code == 200:
+        response_200 = DefinitionJsonhalDefinitionRead.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 404:
+        response_404 = Error.from_dict(response.json())
+
+        return response_404
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[DefinitionJsonhalDefinitionRead, Error]]:
+    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: Union[AuthenticatedClient, Client],
+) -> Response[Union[DefinitionJsonhalDefinitionRead, Error]]:
+    """Retrieves a definition resource.
+
+     Retrieves a definition resource.
+
+    Args:
+        id (str):
+
+    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[Union[DefinitionJsonhalDefinitionRead, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[DefinitionJsonhalDefinitionRead, Error]]:
+    """Retrieves a definition resource.
+
+     Retrieves a definition resource.
+
+    Args:
+        id (str):
+
+    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:
+        Union[DefinitionJsonhalDefinitionRead, Error]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[DefinitionJsonhalDefinitionRead, Error]]:
+    """Retrieves a definition resource.
+
+     Retrieves a definition resource.
+
+    Args:
+        id (str):
+
+    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[Union[DefinitionJsonhalDefinitionRead, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[DefinitionJsonhalDefinitionRead, Error]]:
+    """Retrieves a definition resource.
+
+     Retrieves a definition resource.
+
+    Args:
+        id (str):
+
+    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:
+        Union[DefinitionJsonhalDefinitionRead, Error]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed