arbi 0.1.0__py3-none-any.whl

arbi/resources/api/user/user.py

@@ -0,0 +1,532 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from .settings import (
+    SettingsResource,
+    AsyncSettingsResource,
+    SettingsResourceWithRawResponse,
+    AsyncSettingsResourceWithRawResponse,
+    SettingsResourceWithStreamingResponse,
+    AsyncSettingsResourceWithStreamingResponse,
+)
+from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ...._utils import maybe_transform, async_maybe_transform
+from ...._compat import cached_property
+from ...._resource import SyncAPIResource, AsyncAPIResource
+from ...._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from ....types.api import user_login_params, user_register_params
+from ...._base_client import make_request_options
+from ....types.api.token import Token
+from ....types.api.user_response import UserResponse
+from ....types.api.user_logout_response import UserLogoutResponse
+from ....types.api.user_list_workspaces_response import UserListWorkspacesResponse
+
+__all__ = ["UserResource", "AsyncUserResource"]
+
+
+class UserResource(SyncAPIResource):
+    @cached_property
+    def settings(self) -> SettingsResource:
+        return SettingsResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> UserResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/arbitrationcity/arbi-python#accessing-raw-response-data-eg-headers
+        """
+        return UserResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> UserResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/arbitrationcity/arbi-python#with_streaming_response
+        """
+        return UserResourceWithStreamingResponse(self)
+
+    def list_workspaces(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> UserListWorkspacesResponse:
+        """
+        Retrieve the list of workspaces associated with the current authenticated user.
+        Leverages RLS to enforce access control.
+        """
+        return self._get(
+            "/api/user/workspaces",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=UserListWorkspacesResponse,
+        )
+
+    def login(
+        self,
+        *,
+        email: str,
+        password: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> Token:
+        """
+        Login a user and return a JWT token.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/api/user/login",
+            body=maybe_transform(
+                {
+                    "email": email,
+                    "password": password,
+                },
+                user_login_params.UserLoginParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Token,
+        )
+
+    def logout(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> UserLogoutResponse:
+        """Log out the current user by clearing cached keys and refresh token cookie."""
+        return self._post(
+            "/api/user/logout",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=UserLogoutResponse,
+        )
+
+    def refresh_token(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> Token:
+        """Refresh an expired access token using the refresh token cookie.
+
+        Validates the
+        refresh token and issues a new access token.
+        """
+        return self._post(
+            "/api/user/token_refresh",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Token,
+        )
+
+    def register(
+        self,
+        *,
+        email: str,
+        last_name: str,
+        name: str,
+        password: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> UserResponse:
+        """
+        Register a new user.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/api/user/register",
+            body=maybe_transform(
+                {
+                    "email": email,
+                    "last_name": last_name,
+                    "name": name,
+                    "password": password,
+                },
+                user_register_params.UserRegisterParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=UserResponse,
+        )
+
+    def retrieve_me(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> UserResponse:
+        """Retrieve current authenticated user information.
+
+        This endpoint is useful for
+        validating tokens and checking authentication status.
+        """
+        return self._get(
+            "/api/user/me",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=UserResponse,
+        )
+
+
+class AsyncUserResource(AsyncAPIResource):
+    @cached_property
+    def settings(self) -> AsyncSettingsResource:
+        return AsyncSettingsResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> AsyncUserResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/arbitrationcity/arbi-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncUserResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncUserResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/arbitrationcity/arbi-python#with_streaming_response
+        """
+        return AsyncUserResourceWithStreamingResponse(self)
+
+    async def list_workspaces(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> UserListWorkspacesResponse:
+        """
+        Retrieve the list of workspaces associated with the current authenticated user.
+        Leverages RLS to enforce access control.
+        """
+        return await self._get(
+            "/api/user/workspaces",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=UserListWorkspacesResponse,
+        )
+
+    async def login(
+        self,
+        *,
+        email: str,
+        password: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> Token:
+        """
+        Login a user and return a JWT token.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._post(
+            "/api/user/login",
+            body=await async_maybe_transform(
+                {
+                    "email": email,
+                    "password": password,
+                },
+                user_login_params.UserLoginParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Token,
+        )
+
+    async def logout(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> UserLogoutResponse:
+        """Log out the current user by clearing cached keys and refresh token cookie."""
+        return await self._post(
+            "/api/user/logout",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=UserLogoutResponse,
+        )
+
+    async def refresh_token(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> Token:
+        """Refresh an expired access token using the refresh token cookie.
+
+        Validates the
+        refresh token and issues a new access token.
+        """
+        return await self._post(
+            "/api/user/token_refresh",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Token,
+        )
+
+    async def register(
+        self,
+        *,
+        email: str,
+        last_name: str,
+        name: str,
+        password: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> UserResponse:
+        """
+        Register a new user.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._post(
+            "/api/user/register",
+            body=await async_maybe_transform(
+                {
+                    "email": email,
+                    "last_name": last_name,
+                    "name": name,
+                    "password": password,
+                },
+                user_register_params.UserRegisterParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=UserResponse,
+        )
+
+    async def retrieve_me(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> UserResponse:
+        """Retrieve current authenticated user information.
+
+        This endpoint is useful for
+        validating tokens and checking authentication status.
+        """
+        return await self._get(
+            "/api/user/me",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=UserResponse,
+        )
+
+
+class UserResourceWithRawResponse:
+    def __init__(self, user: UserResource) -> None:
+        self._user = user
+
+        self.list_workspaces = to_raw_response_wrapper(
+            user.list_workspaces,
+        )
+        self.login = to_raw_response_wrapper(
+            user.login,
+        )
+        self.logout = to_raw_response_wrapper(
+            user.logout,
+        )
+        self.refresh_token = to_raw_response_wrapper(
+            user.refresh_token,
+        )
+        self.register = to_raw_response_wrapper(
+            user.register,
+        )
+        self.retrieve_me = to_raw_response_wrapper(
+            user.retrieve_me,
+        )
+
+    @cached_property
+    def settings(self) -> SettingsResourceWithRawResponse:
+        return SettingsResourceWithRawResponse(self._user.settings)
+
+
+class AsyncUserResourceWithRawResponse:
+    def __init__(self, user: AsyncUserResource) -> None:
+        self._user = user
+
+        self.list_workspaces = async_to_raw_response_wrapper(
+            user.list_workspaces,
+        )
+        self.login = async_to_raw_response_wrapper(
+            user.login,
+        )
+        self.logout = async_to_raw_response_wrapper(
+            user.logout,
+        )
+        self.refresh_token = async_to_raw_response_wrapper(
+            user.refresh_token,
+        )
+        self.register = async_to_raw_response_wrapper(
+            user.register,
+        )
+        self.retrieve_me = async_to_raw_response_wrapper(
+            user.retrieve_me,
+        )
+
+    @cached_property
+    def settings(self) -> AsyncSettingsResourceWithRawResponse:
+        return AsyncSettingsResourceWithRawResponse(self._user.settings)
+
+
+class UserResourceWithStreamingResponse:
+    def __init__(self, user: UserResource) -> None:
+        self._user = user
+
+        self.list_workspaces = to_streamed_response_wrapper(
+            user.list_workspaces,
+        )
+        self.login = to_streamed_response_wrapper(
+            user.login,
+        )
+        self.logout = to_streamed_response_wrapper(
+            user.logout,
+        )
+        self.refresh_token = to_streamed_response_wrapper(
+            user.refresh_token,
+        )
+        self.register = to_streamed_response_wrapper(
+            user.register,
+        )
+        self.retrieve_me = to_streamed_response_wrapper(
+            user.retrieve_me,
+        )
+
+    @cached_property
+    def settings(self) -> SettingsResourceWithStreamingResponse:
+        return SettingsResourceWithStreamingResponse(self._user.settings)
+
+
+class AsyncUserResourceWithStreamingResponse:
+    def __init__(self, user: AsyncUserResource) -> None:
+        self._user = user
+
+        self.list_workspaces = async_to_streamed_response_wrapper(
+            user.list_workspaces,
+        )
+        self.login = async_to_streamed_response_wrapper(
+            user.login,
+        )
+        self.logout = async_to_streamed_response_wrapper(
+            user.logout,
+        )
+        self.refresh_token = async_to_streamed_response_wrapper(
+            user.refresh_token,
+        )
+        self.register = async_to_streamed_response_wrapper(
+            user.register,
+        )
+        self.retrieve_me = async_to_streamed_response_wrapper(
+            user.retrieve_me,
+        )
+
+    @cached_property
+    def settings(self) -> AsyncSettingsResourceWithStreamingResponse:
+        return AsyncSettingsResourceWithStreamingResponse(self._user.settings)