skillforge-client 0.4.0__tar.gz → 0.5.0__tar.gz

{skillforge_client-0.4.0 → skillforge_client-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: skillforge-client
-Version: 0.4.0
+Version: 0.5.0
 Summary: Official Python client for the Skillforge API.
 Keywords: skillforge,api,client,openapi
 Author: Leon Weimann
@@ -15,7 +15,7 @@ Requires-Dist: attrs>=22.2.0
 Requires-Python: >=3.11
 Project-URL: Repository, https://github.com/Nachhilfe-Leon-Weimann/skillforge
 Project-URL: Issues, https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues
-Project-URL: OpenAPI contract, https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.4.0/openapi.json
+Project-URL: OpenAPI contract, https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.5.0/openapi.json
 Description-Content-Type: text/markdown
 
 # Skillforge Python Client
@@ -77,7 +77,7 @@ Generated request and response models are available from `skillforge_client.mode
 
 ## Versioning and source
 
-Client versions follow Skillforge releases. This package was generated from the [`openapi.json`](https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.4.0/openapi.json) contract for Skillforge v0.4.0; generated source is not maintained by hand.
+Client versions follow Skillforge releases. This package was generated from the [`openapi.json`](https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.5.0/openapi.json) contract for Skillforge v0.5.0; generated source is not maintained by hand.
 
 - [Skillforge repository](https://github.com/Nachhilfe-Leon-Weimann/skillforge)
 - [Issue tracker](https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues)

{skillforge_client-0.4.0 → skillforge_client-0.5.0}/README.md

@@ -57,7 +57,7 @@ Generated request and response models are available from `skillforge_client.mode
 
 ## Versioning and source
 
-Client versions follow Skillforge releases. This package was generated from the [`openapi.json`](https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.4.0/openapi.json) contract for Skillforge v0.4.0; generated source is not maintained by hand.
+Client versions follow Skillforge releases. This package was generated from the [`openapi.json`](https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.5.0/openapi.json) contract for Skillforge v0.5.0; generated source is not maintained by hand.
 
 - [Skillforge repository](https://github.com/Nachhilfe-Leon-Weimann/skillforge)
 - [Issue tracker](https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues)

{skillforge_client-0.4.0 → skillforge_client-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "skillforge-client"
-version = "0.4.0"
+version = "0.5.0"
 description = "Official Python client for the Skillforge API."
 requires-python = ">=3.11"
 readme = "README.md"
@@ -29,7 +29,7 @@ email = "coding@leonweimann.de"
 [project.urls]
 Repository = "https://github.com/Nachhilfe-Leon-Weimann/skillforge"
 Issues = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues"
-"OpenAPI contract" = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.4.0/openapi.json"
+"OpenAPI contract" = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.5.0/openapi.json"
 
 [tool.uv.build-backend]
 module-name = "skillforge_client"

{skillforge_client-0.4.0 → skillforge_client-0.5.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "skillforge-client"
-version = "0.4.0"
+version = "0.5.0"
 description = "Official Python client for the Skillforge API."
 authors = [{ name = "Leon Weimann", email = "coding@leonweimann.de" }]
 requires-python = ">=3.11"
@@ -21,7 +21,7 @@ dependencies = [
 [project.urls]
 Repository = "https://github.com/Nachhilfe-Leon-Weimann/skillforge"
 Issues = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/issues"
-"OpenAPI contract" = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.4.0/openapi.json"
+"OpenAPI contract" = "https://github.com/Nachhilfe-Leon-Weimann/skillforge/blob/v0.5.0/openapi.json"
 
 [tool.uv.build-backend]
 module-name = "skillforge_client"

skillforge_client-0.5.0/skillforge_client/api/auth/auth_add_user_role.py

@@ -0,0 +1,200 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error_response import ErrorResponse
+from ...models.user_account_detail import UserAccountDetail
+from ...models.user_account_role_name import UserAccountRoleName
+from ...types import Response
+
+
+def _get_kwargs(
+    user_id: UUID,
+    role: UserAccountRoleName,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "put",
+        "url": "/api/v1/auth/users/{user_id}/roles/{role}".format(
+            user_id=quote(str(user_id), safe=""),
+            role=quote(str(role), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ErrorResponse | UserAccountDetail | None:
+    if response.status_code == 200:
+        response_200 = UserAccountDetail.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = ErrorResponse.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 422:
+        response_422 = ErrorResponse.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[ErrorResponse | UserAccountDetail]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    user_id: UUID,
+    role: UserAccountRoleName,
+    *,
+    client: AuthenticatedClient,
+) -> Response[ErrorResponse | UserAccountDetail]:
+    """Add User Role
+
+     Give the account a stored role. Idempotent: a role it already holds changes nothing.
+
+    Args:
+        user_id (UUID): ID of the user account.
+        role (UserAccountRoleName):
+
+    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[ErrorResponse | UserAccountDetail]
+    """
+
+    kwargs = _get_kwargs(
+        user_id=user_id,
+        role=role,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    user_id: UUID,
+    role: UserAccountRoleName,
+    *,
+    client: AuthenticatedClient,
+) -> ErrorResponse | UserAccountDetail | None:
+    """Add User Role
+
+     Give the account a stored role. Idempotent: a role it already holds changes nothing.
+
+    Args:
+        user_id (UUID): ID of the user account.
+        role (UserAccountRoleName):
+
+    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:
+        ErrorResponse | UserAccountDetail
+    """
+
+    return sync_detailed(
+        user_id=user_id,
+        role=role,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    user_id: UUID,
+    role: UserAccountRoleName,
+    *,
+    client: AuthenticatedClient,
+) -> Response[ErrorResponse | UserAccountDetail]:
+    """Add User Role
+
+     Give the account a stored role. Idempotent: a role it already holds changes nothing.
+
+    Args:
+        user_id (UUID): ID of the user account.
+        role (UserAccountRoleName):
+
+    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[ErrorResponse | UserAccountDetail]
+    """
+
+    kwargs = _get_kwargs(
+        user_id=user_id,
+        role=role,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    user_id: UUID,
+    role: UserAccountRoleName,
+    *,
+    client: AuthenticatedClient,
+) -> ErrorResponse | UserAccountDetail | None:
+    """Add User Role
+
+     Give the account a stored role. Idempotent: a role it already holds changes nothing.
+
+    Args:
+        user_id (UUID): ID of the user account.
+        role (UserAccountRoleName):
+
+    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:
+        ErrorResponse | UserAccountDetail
+    """
+
+    return (
+        await asyncio_detailed(
+            user_id=user_id,
+            role=role,
+            client=client,
+        )
+    ).parsed

{skillforge_client-0.4.0 → skillforge_client-0.5.0}/skillforge_client/api/auth/auth_create_token.py

@@ -76,6 +76,17 @@ def sync_detailed(
 ) -> Response[AccessTokenResponse | ErrorResponse]:
     """Create Token
 
+     Issue an access token.
+
+    The client authenticates for every grant, with HTTP Basic or `client_id` / `client_secret` in the
+    form.
+    `client_credentials` issues a token of the client's own. `password` logs a person in and opens a
+    session;
+    `refresh_token` renews it and replaces its refresh token. Both need `auth:users:login` granted to
+    the client
+    in `application` mode. Every failure of the person's credentials or refresh token is the same
+    `invalid_grant`.
+
     Args:
         body (BodyAuthCreateToken):
 
@@ -105,6 +116,17 @@ def sync(
 ) -> AccessTokenResponse | ErrorResponse | None:
     """Create Token
 
+     Issue an access token.
+
+    The client authenticates for every grant, with HTTP Basic or `client_id` / `client_secret` in the
+    form.
+    `client_credentials` issues a token of the client's own. `password` logs a person in and opens a
+    session;
+    `refresh_token` renews it and replaces its refresh token. Both need `auth:users:login` granted to
+    the client
+    in `application` mode. Every failure of the person's credentials or refresh token is the same
+    `invalid_grant`.
+
     Args:
         body (BodyAuthCreateToken):
 
@@ -129,6 +151,17 @@ async def asyncio_detailed(
 ) -> Response[AccessTokenResponse | ErrorResponse]:
     """Create Token
 
+     Issue an access token.
+
+    The client authenticates for every grant, with HTTP Basic or `client_id` / `client_secret` in the
+    form.
+    `client_credentials` issues a token of the client's own. `password` logs a person in and opens a
+    session;
+    `refresh_token` renews it and replaces its refresh token. Both need `auth:users:login` granted to
+    the client
+    in `application` mode. Every failure of the person's credentials or refresh token is the same
+    `invalid_grant`.
+
     Args:
         body (BodyAuthCreateToken):
 
@@ -156,6 +189,17 @@ async def asyncio(
 ) -> AccessTokenResponse | ErrorResponse | None:
     """Create Token
 
+     Issue an access token.
+
+    The client authenticates for every grant, with HTTP Basic or `client_id` / `client_secret` in the
+    form.
+    `client_credentials` issues a token of the client's own. `password` logs a person in and opens a
+    session;
+    `refresh_token` renews it and replaces its refresh token. Both need `auth:users:login` granted to
+    the client
+    in `application` mode. Every failure of the person's credentials or refresh token is the same
+    `invalid_grant`.
+
     Args:
         body (BodyAuthCreateToken):
 

skillforge_client-0.5.0/skillforge_client/api/auth/auth_create_user.py

@@ -0,0 +1,201 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error_response import ErrorResponse
+from ...models.user_account_create_request import UserAccountCreateRequest
+from ...models.user_account_detail import UserAccountDetail
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: UserAccountCreateRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/auth/users",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ErrorResponse | UserAccountDetail | None:
+    if response.status_code == 201:
+        response_201 = UserAccountDetail.from_dict(response.json())
+
+        return response_201
+
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = ErrorResponse.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 409:
+        response_409 = ErrorResponse.from_dict(response.json())
+
+        return response_409
+
+    if response.status_code == 422:
+        response_422 = ErrorResponse.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[ErrorResponse | UserAccountDetail]:
+    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: UserAccountCreateRequest,
+) -> Response[ErrorResponse | UserAccountDetail]:
+    """Create User
+
+     Create an `active` account for a person party.
+
+    The response carries no token: set up the password login with `POST /users/{user_id}/invitation`.
+
+    Args:
+        body (UserAccountCreateRequest): Body of `POST /users`: the person party an account is
+            created for.
+
+    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[ErrorResponse | UserAccountDetail]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: UserAccountCreateRequest,
+) -> ErrorResponse | UserAccountDetail | None:
+    """Create User
+
+     Create an `active` account for a person party.
+
+    The response carries no token: set up the password login with `POST /users/{user_id}/invitation`.
+
+    Args:
+        body (UserAccountCreateRequest): Body of `POST /users`: the person party an account is
+            created for.
+
+    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:
+        ErrorResponse | UserAccountDetail
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: UserAccountCreateRequest,
+) -> Response[ErrorResponse | UserAccountDetail]:
+    """Create User
+
+     Create an `active` account for a person party.
+
+    The response carries no token: set up the password login with `POST /users/{user_id}/invitation`.
+
+    Args:
+        body (UserAccountCreateRequest): Body of `POST /users`: the person party an account is
+            created for.
+
+    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[ErrorResponse | UserAccountDetail]
+    """
+
+    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: UserAccountCreateRequest,
+) -> ErrorResponse | UserAccountDetail | None:
+    """Create User
+
+     Create an `active` account for a person party.
+
+    The response carries no token: set up the password login with `POST /users/{user_id}/invitation`.
+
+    Args:
+        body (UserAccountCreateRequest): Body of `POST /users`: the person party an account is
+            created for.
+
+    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:
+        ErrorResponse | UserAccountDetail
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed