`helpjuice.api.user`

Helpjuice Users API.

https://help.helpjuice.com/en_US/api-v3/api-v3#users

Module Contents

Classes

`User`	User
`Users`	User collection.

class helpjuice.api.user.User

Bases: helpjuice.api.schema.Resource

User

https://help.helpjuice.com/en_US/api-v3/api-v3#users

first_name

First name of the user.

Type: str

last_name

Last name of the user.

Type: str

email

Unique email of the user.

Type: str

role_id

Role of the user.

Type: str

group_ids

Ids of the groups where the user should be joined.

Type: list

get()

Retrieve a user.

https://help.helpjuice.com/en_US/api-v3/api-v3#retrieve-a-user

Returns: Requested user.
Return type: helpjuice.api.User

post()

Create a New user.

https://help.helpjuice.com/en_US/api-v3/api-v3#create-a-new-user

Returns: Requested user.
Return type: helpjuice.api.User

put()

Update a user.

https://help.helpjuice.com/en_US/api-v3/api-v3#retrieve-a-user

Returns: Requested user.
Return type: helpjuice.api.User

delete()

Retrieve a user.

https://help.helpjuice.com/en_US/api-v3/api-v3#retrieve-a-user

Returns: Requested user.
Return type: helpjuice.api.User

class helpjuice.api.user.Users

Bases: helpjuice.api.schema.Collection

User collection.

https://help.helpjuice.com/en_US/api-v3/api-v3#users

resource

get(*args, **kwargs)

Retrieve all users.

https://help.helpjuice.com/en_US/api-v3/api-v3#retrieve-all-users

Returns: Requested users.
Return type: helpjuice.api.Users