kavita_client.api.account.get_api_account_invite_url

Module Contents

Functions

asyncio	Requests the Invite Url for the AppUserId. Will return error if user is already validated.
asyncio_detailed	Requests the Invite Url for the AppUserId. Will return error if user is already validated.
sync	Requests the Invite Url for the AppUserId. Will return error if user is already validated.
sync_detailed	Requests the Invite Url for the AppUserId. Will return error if user is already validated.

API

async kavita_client.api.account.get_api_account_invite_url.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, user_id: int | kavita_client.types.Unset = UNSET, with_base_url: bool | kavita_client.types.Unset = UNSET) → str | None

Requests the Invite Url for the AppUserId. Will return error if user is already validated.

Args:

user_id (int | Unset): with_base_url (bool | 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:

str

async kavita_client.api.account.get_api_account_invite_url.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, user_id: int | kavita_client.types.Unset = UNSET, with_base_url: bool | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[str]

Requests the Invite Url for the AppUserId. Will return error if user is already validated.

Args:

user_id (int | Unset): with_base_url (bool | 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[str]

kavita_client.api.account.get_api_account_invite_url.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, user_id: int | kavita_client.types.Unset = UNSET, with_base_url: bool | kavita_client.types.Unset = UNSET) → str | None

Requests the Invite Url for the AppUserId. Will return error if user is already validated.

Args:

user_id (int | Unset): with_base_url (bool | 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:

str

kavita_client.api.account.get_api_account_invite_url.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, user_id: int | kavita_client.types.Unset = UNSET, with_base_url: bool | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[str]

Requests the Invite Url for the AppUserId. Will return error if user is already validated.

Args:

user_id (int | Unset): with_base_url (bool | 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[str]