Users

class UsersService(client: UsersClient)

Service class for users

Developers has option to use this service directly or use the Fider client.

create_user(request: CreateUserRequest) → FiderAPIResponse[CreateUserResponse]

Create a new user

Example:

>>> from fiderpy.v1.resources.users import request
>>> from fiderpy.v1.resources.users.service import UsersService

>>> service = UsersService(client=UsersClient(http=http))
>>> request = CreateUserRequest(name="John Doe", email="john@example.com")
>>> response = service.create_user(request=request)
>>> response
FiderAPIResponse(
    message="Successfully created user!",
    data=CreateUserResponse(
        id=1,
        name="John Doe",
        email="john@example.com",
        role="user",
        status="active"
    ),
    errors=None
)

Parameters:

request – fiderpy.v1.resources.users.request.CreateUserRequest

Returns:

fiderpy.v1.utils.domain.FiderAPIResponse

get_users() → FiderAPIResponse[list[User]]

Get all users

Example:

>>> from fiderpy.v1.resources.users.service import UsersService

>>> service = UsersService(client=UsersClient(http=http))
>>> response = service.get_users()
>>> response
FiderAPIResponse(
    message="Successfully fetched data.",
    data=[
        User(
            id=1,
            name="John Doe",
            role="user",
            email="john@example.com",
            status="active"
        ),
    ],
    errors=None
)

Returns:

fiderpy.v1.utils.domain.FiderAPIResponse