docket-client 0.3.2__py3-none-any.whl

docket/__init__.py

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

docket/api/__init__.py

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

docket/api/access/__init__.py

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

docket/api/access/add_principal.py

@@ -0,0 +1,193 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.add_principal_request import AddPrincipalRequest
+from ...models.http_validation_problem_details import HttpValidationProblemDetails
+from ...models.principal_response import PrincipalResponse
+from ...models.problem_details import ProblemDetails
+from typing import cast
+
+
+def _get_kwargs(
+    *,
+    body: AddPrincipalRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/access/principals",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HttpValidationProblemDetails | PrincipalResponse | ProblemDetails | None:
+    if response.status_code == 201:
+        response_201 = PrincipalResponse.from_dict(response.json())
+
+        return response_201
+
+    if response.status_code == 401:
+        response_401 = ProblemDetails.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = ProblemDetails.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 409:
+        response_409 = ProblemDetails.from_dict(response.json())
+
+        return response_409
+
+    if response.status_code == 422:
+        response_422 = HttpValidationProblemDetails.from_dict(response.json())
+
+        return response_422
+
+    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[HttpValidationProblemDetails | PrincipalResponse | ProblemDetails]:
+    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: AuthenticatedClient,
+    body: AddPrincipalRequest,
+) -> Response[HttpValidationProblemDetails | PrincipalResponse | ProblemDetails]:
+    """Register a principal by Entra object id before it has signed in (how rig applications with an Entra
+    registration are added). Admin only.
+
+    Args:
+        body (AddPrincipalRequest): Registers a principal before it has signed in (how rig
+            applications are added).
+
+    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[HttpValidationProblemDetails | PrincipalResponse | ProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: AddPrincipalRequest,
+) -> HttpValidationProblemDetails | PrincipalResponse | ProblemDetails | None:
+    """Register a principal by Entra object id before it has signed in (how rig applications with an Entra
+    registration are added). Admin only.
+
+    Args:
+        body (AddPrincipalRequest): Registers a principal before it has signed in (how rig
+            applications are added).
+
+    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:
+        HttpValidationProblemDetails | PrincipalResponse | ProblemDetails
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: AddPrincipalRequest,
+) -> Response[HttpValidationProblemDetails | PrincipalResponse | ProblemDetails]:
+    """Register a principal by Entra object id before it has signed in (how rig applications with an Entra
+    registration are added). Admin only.
+
+    Args:
+        body (AddPrincipalRequest): Registers a principal before it has signed in (how rig
+            applications are added).
+
+    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[HttpValidationProblemDetails | PrincipalResponse | ProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: AddPrincipalRequest,
+) -> HttpValidationProblemDetails | PrincipalResponse | ProblemDetails | None:
+    """Register a principal by Entra object id before it has signed in (how rig applications with an Entra
+    registration are added). Admin only.
+
+    Args:
+        body (AddPrincipalRequest): Registers a principal before it has signed in (how rig
+            applications are added).
+
+    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:
+        HttpValidationProblemDetails | PrincipalResponse | ProblemDetails
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

docket/api/access/archive_role_assignment.py

@@ -0,0 +1,182 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.problem_details import ProblemDetails
+from ...models.role_assignment_response import RoleAssignmentResponse
+from typing import cast
+
+
+def _get_kwargs(
+    id: int,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/access/assignments/{id}/archive".format(
+            id=quote(str(id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ProblemDetails | RoleAssignmentResponse | None:
+    if response.status_code == 200:
+        response_200 = RoleAssignmentResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = ProblemDetails.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = ProblemDetails.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 404:
+        response_404 = ProblemDetails.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 409:
+        response_409 = ProblemDetails.from_dict(response.json())
+
+        return response_409
+
+    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[ProblemDetails | RoleAssignmentResponse]:
+    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: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[ProblemDetails | RoleAssignmentResponse]:
+    """Remove a role (archive the assignment). The last Admin cannot be removed unless bootstrap admins are
+    configured (409 last_admin). Admin only.
+
+    Args:
+        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[ProblemDetails | RoleAssignmentResponse]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> ProblemDetails | RoleAssignmentResponse | None:
+    """Remove a role (archive the assignment). The last Admin cannot be removed unless bootstrap admins are
+    configured (409 last_admin). Admin only.
+
+    Args:
+        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:
+        ProblemDetails | RoleAssignmentResponse
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[ProblemDetails | RoleAssignmentResponse]:
+    """Remove a role (archive the assignment). The last Admin cannot be removed unless bootstrap admins are
+    configured (409 last_admin). Admin only.
+
+    Args:
+        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[ProblemDetails | RoleAssignmentResponse]
+    """
+
+    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: int,
+    *,
+    client: AuthenticatedClient,
+) -> ProblemDetails | RoleAssignmentResponse | None:
+    """Remove a role (archive the assignment). The last Admin cannot be removed unless bootstrap admins are
+    configured (409 last_admin). Admin only.
+
+    Args:
+        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:
+        ProblemDetails | RoleAssignmentResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed

docket/api/access/create_api_token.py

@@ -0,0 +1,198 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.create_api_token_request import CreateApiTokenRequest
+from ...models.created_api_token_response import CreatedApiTokenResponse
+from ...models.http_validation_problem_details import HttpValidationProblemDetails
+from ...models.problem_details import ProblemDetails
+from typing import cast
+
+
+def _get_kwargs(
+    *,
+    body: CreateApiTokenRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/access/tokens",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails | None:
+    if response.status_code == 201:
+        response_201 = CreatedApiTokenResponse.from_dict(response.json())
+
+        return response_201
+
+    if response.status_code == 401:
+        response_401 = ProblemDetails.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = ProblemDetails.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 404:
+        response_404 = ProblemDetails.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 409:
+        response_409 = ProblemDetails.from_dict(response.json())
+
+        return response_409
+
+    if response.status_code == 422:
+        response_422 = HttpValidationProblemDetails.from_dict(response.json())
+
+        return response_422
+
+    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[CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails]:
+    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: AuthenticatedClient,
+    body: CreateApiTokenRequest,
+) -> Response[CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails]:
+    """Issue an API token for a principal. The full token is in this response only; it is not stored and
+    cannot be shown again. It acts as the principal and has exactly its roles. Not available for
+    bootstrap admins. Admin only.
+
+    Args:
+        body (CreateApiTokenRequest): Issues an API token.
+
+    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[CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: CreateApiTokenRequest,
+) -> CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails | None:
+    """Issue an API token for a principal. The full token is in this response only; it is not stored and
+    cannot be shown again. It acts as the principal and has exactly its roles. Not available for
+    bootstrap admins. Admin only.
+
+    Args:
+        body (CreateApiTokenRequest): Issues an API token.
+
+    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:
+        CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: CreateApiTokenRequest,
+) -> Response[CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails]:
+    """Issue an API token for a principal. The full token is in this response only; it is not stored and
+    cannot be shown again. It acts as the principal and has exactly its roles. Not available for
+    bootstrap admins. Admin only.
+
+    Args:
+        body (CreateApiTokenRequest): Issues an API token.
+
+    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[CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: CreateApiTokenRequest,
+) -> CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails | None:
+    """Issue an API token for a principal. The full token is in this response only; it is not stored and
+    cannot be shown again. It acts as the principal and has exactly its roles. Not available for
+    bootstrap admins. Admin only.
+
+    Args:
+        body (CreateApiTokenRequest): Issues an API token.
+
+    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:
+        CreatedApiTokenResponse | HttpValidationProblemDetails | ProblemDetails
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed