qcs_api_client 0.27.3__py3-none-any.whl

qcs_api_client/__init__.py

@@ -0,0 +1 @@
+"""A client library for accessing Rigetti QCS API"""

qcs_api_client/api/__init__.py

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

qcs_api_client/api/account/__init__.py

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

qcs_api_client/api/account/activate_user.py

@@ -0,0 +1,155 @@
+from typing import Any
+
+import httpx
+from tenacity import retry
+
+from ...models.activate_user_request import ActivateUserRequest
+from ...models.error import Error
+from ...models.user import User
+from ...types import UNSET, Response, Unset
+from ...util.errors import QCSHTTPStatusError
+from ...util.retry import DEFAULT_RETRY_ARGUMENTS
+
+
+def _get_kwargs(
+    *,
+    body: ActivateUserRequest | Unset = UNSET,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/users:activate",
+    }
+
+    if not isinstance(body, Unset):
+        _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, response: httpx.Response) -> Error | User | None:
+    if response.status_code == 204:
+        response_204 = User.from_dict(response.json())
+
+        return response_204
+
+    raise QCSHTTPStatusError(
+        message=f"Unexpected response: status code {response.status_code}",
+        response=response,
+    )
+
+
+def _build_response(*, response: httpx.Response) -> Response[Error | User]:
+    """Construct the Response class from the raw ``httpx.Response``."""
+    return Response.build_from_httpx_response(response=response, parse_function=_parse_response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+def sync(
+    *,
+    client: httpx.Client,
+    body: ActivateUserRequest | Unset = UNSET,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Error | User]:
+    """Activate User
+
+     Activate a user, completing an invitation request.
+
+    Args:
+        body (ActivateUserRequest | Unset):
+
+    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 | User]
+    """
+
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = client.request(
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+def sync_from_dict(
+    *,
+    client: httpx.Client,
+    body: dict,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Error | User]:
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        client=client,
+        body=body,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = client.request(
+        **kwargs,
+    )
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+async def asyncio(
+    *,
+    client: httpx.AsyncClient,
+    body: ActivateUserRequest | Unset = UNSET,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Error | User]:
+    """Activate User
+
+     Activate a user, completing an invitation request.
+
+    Args:
+        body (ActivateUserRequest | Unset):
+
+    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 | User]
+    """
+
+    httpx_request_kwargs = httpx_request_kwargs or {}
+    kwargs = _get_kwargs(
+        body=body,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = await client.request(**kwargs)
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+async def asyncio_from_dict(
+    *,
+    client: httpx.AsyncClient,
+    body: dict,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Error | User]:
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        client=client,
+        body=body,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = await client.request(
+        **kwargs,
+    )
+
+    return _build_response(response=response)

qcs_api_client/api/account/add_group_user.py

@@ -0,0 +1,156 @@
+from typing import Any, cast
+
+import httpx
+from tenacity import retry
+
+from ...models.add_group_user_request import AddGroupUserRequest
+from ...models.error import Error
+from ...types import Response
+from ...util.errors import QCSHTTPStatusError
+from ...util.retry import DEFAULT_RETRY_ARGUMENTS
+
+
+def _get_kwargs(
+    *,
+    body: AddGroupUserRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/groups:addUser",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, response: httpx.Response) -> Any | Error | None:
+    if response.status_code == 204:
+        response_204 = cast(Any, None)
+        return response_204
+
+    raise QCSHTTPStatusError(
+        message=f"Unexpected response: status code {response.status_code}",
+        response=response,
+    )
+
+
+def _build_response(*, response: httpx.Response) -> Response[Any | Error]:
+    """Construct the Response class from the raw ``httpx.Response``."""
+    return Response.build_from_httpx_response(response=response, parse_function=_parse_response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+def sync(
+    *,
+    client: httpx.Client,
+    body: AddGroupUserRequest,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Any | Error]:
+    """Add user to a group
+
+     Add a user to a group. Note, group membership may take several minutes to update within our identity
+    provider. After adding a user to a group, please allow up to 60 minutes for changes to be reflected.
+
+    Args:
+        body (AddGroupUserRequest): Must provide either `userId` or `userEmail` and `groupId` or
+            `groupName`.
+
+    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[Any | Error]
+    """
+
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = client.request(
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+def sync_from_dict(
+    *,
+    client: httpx.Client,
+    body: dict,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Any | Error]:
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        client=client,
+        body=body,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = client.request(
+        **kwargs,
+    )
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+async def asyncio(
+    *,
+    client: httpx.AsyncClient,
+    body: AddGroupUserRequest,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Any | Error]:
+    """Add user to a group
+
+     Add a user to a group. Note, group membership may take several minutes to update within our identity
+    provider. After adding a user to a group, please allow up to 60 minutes for changes to be reflected.
+
+    Args:
+        body (AddGroupUserRequest): Must provide either `userId` or `userEmail` and `groupId` or
+            `groupName`.
+
+    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[Any | Error]
+    """
+
+    httpx_request_kwargs = httpx_request_kwargs or {}
+    kwargs = _get_kwargs(
+        body=body,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = await client.request(**kwargs)
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+async def asyncio_from_dict(
+    *,
+    client: httpx.AsyncClient,
+    body: dict,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Any | Error]:
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        client=client,
+        body=body,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = await client.request(
+        **kwargs,
+    )
+
+    return _build_response(response=response)

qcs_api_client/api/account/dismiss_viewer_announcement.py

@@ -0,0 +1,145 @@
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+from tenacity import retry
+
+from ...models.error import Error
+from ...types import Response
+from ...util.errors import QCSHTTPStatusError
+from ...util.retry import DEFAULT_RETRY_ARGUMENTS
+
+
+def _get_kwargs(
+    announcement_id: int,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/v1/viewer/announcements/{announcement_id}".format(
+            announcement_id=quote(str(announcement_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, response: httpx.Response) -> Any | Error | None:
+    if response.status_code == 200:
+        response_200 = cast(Any, None)
+        return response_200
+
+    raise QCSHTTPStatusError(
+        message=f"Unexpected response: status code {response.status_code}",
+        response=response,
+    )
+
+
+def _build_response(*, response: httpx.Response) -> Response[Any | Error]:
+    """Construct the Response class from the raw ``httpx.Response``."""
+    return Response.build_from_httpx_response(response=response, parse_function=_parse_response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+def sync(
+    announcement_id: int,
+    *,
+    client: httpx.Client,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Any | Error]:
+    """Dismiss an announcement for an authenticating user, indicating that they do not want to see it
+    again.
+
+    Args:
+        announcement_id (int):
+
+    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[Any | Error]
+    """
+
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        announcement_id=announcement_id,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = client.request(
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+def sync_from_dict(
+    announcement_id: int,
+    *,
+    client: httpx.Client,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Any | Error]:
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        announcement_id=announcement_id,
+        client=client,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = client.request(
+        **kwargs,
+    )
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+async def asyncio(
+    announcement_id: int,
+    *,
+    client: httpx.AsyncClient,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Any | Error]:
+    """Dismiss an announcement for an authenticating user, indicating that they do not want to see it
+    again.
+
+    Args:
+        announcement_id (int):
+
+    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[Any | Error]
+    """
+
+    httpx_request_kwargs = httpx_request_kwargs or {}
+    kwargs = _get_kwargs(
+        announcement_id=announcement_id,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = await client.request(**kwargs)
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+async def asyncio_from_dict(
+    announcement_id: int,
+    *,
+    client: httpx.AsyncClient,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[Any | Error]:
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        announcement_id=announcement_id,
+        client=client,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = await client.request(
+        **kwargs,
+    )
+
+    return _build_response(response=response)

qcs_api_client/api/account/get_group_balance.py

@@ -0,0 +1,149 @@
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+from tenacity import retry
+
+from ...models.account_balance import AccountBalance
+from ...models.error import Error
+from ...types import Response
+from ...util.errors import QCSHTTPStatusError
+from ...util.retry import DEFAULT_RETRY_ARGUMENTS
+
+
+def _get_kwargs(
+    group_name: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/groups/{group_name}/balance".format(
+            group_name=quote(str(group_name), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, response: httpx.Response) -> AccountBalance | Error | None:
+    if response.status_code == 200:
+        response_200 = AccountBalance.from_dict(response.json())
+
+        return response_200
+
+    raise QCSHTTPStatusError(
+        message=f"Unexpected response: status code {response.status_code}",
+        response=response,
+    )
+
+
+def _build_response(*, response: httpx.Response) -> Response[AccountBalance | Error]:
+    """Construct the Response class from the raw ``httpx.Response``."""
+    return Response.build_from_httpx_response(response=response, parse_function=_parse_response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+def sync(
+    group_name: str,
+    *,
+    client: httpx.Client,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[AccountBalance | Error]:
+    """Get Group Balance
+
+     Retrieve the balance of the requested QCS group account.
+
+    Args:
+        group_name (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[AccountBalance | Error]
+    """
+
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        group_name=group_name,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = client.request(
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+def sync_from_dict(
+    group_name: str,
+    *,
+    client: httpx.Client,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[AccountBalance | Error]:
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        group_name=group_name,
+        client=client,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = client.request(
+        **kwargs,
+    )
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+async def asyncio(
+    group_name: str,
+    *,
+    client: httpx.AsyncClient,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[AccountBalance | Error]:
+    """Get Group Balance
+
+     Retrieve the balance of the requested QCS group account.
+
+    Args:
+        group_name (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[AccountBalance | Error]
+    """
+
+    httpx_request_kwargs = httpx_request_kwargs or {}
+    kwargs = _get_kwargs(
+        group_name=group_name,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = await client.request(**kwargs)
+    return _build_response(response=response)
+
+
+@retry(**DEFAULT_RETRY_ARGUMENTS)
+async def asyncio_from_dict(
+    group_name: str,
+    *,
+    client: httpx.AsyncClient,
+    httpx_request_kwargs: dict[str, Any] | None = None,
+) -> Response[AccountBalance | Error]:
+    httpx_request_kwargs = httpx_request_kwargs or {}
+
+    kwargs = _get_kwargs(
+        group_name=group_name,
+        client=client,
+    )
+    kwargs.update(httpx_request_kwargs)
+    response = await client.request(
+        **kwargs,
+    )
+
+    return _build_response(response=response)