helpjuice.api.group

Helpjuice Groups API.

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

Module Contents

Classes

Group

Group resource.

Groups

Group resource collection.

class helpjuice.api.group.Group

Bases: helpjuice.api.schema.Resource

Group resource.

name

Name of the group.

Type

str

smart_load

Enable smart loading users in this group.

Type

bool

user_ids

Join users to this group.

Type

list

auto_groups

A comma-separated string of email extension that will be auto-loaded to this group. smart_load has to be enabled.

Type

str

get()

Retrieve an group.

https://help.helpjuice.com/en_US/api-v3/api-v3#retrieve-an-group

Returns

helpjuice.api.Group

post()

Create an group.

https://help.helpjuice.com/en_US/api-v3/api-v3#create-an-group

Returns

helpjuice.api.Group

put()

Update an group.

https://help.helpjuice.com/en_US/api-v3/api-v3#update-an-group

Returns

helpjuice.api.Group

delete()

Delete an group.

https://help.helpjuice.com/en_US/api-v3/api-v3#delete-an-group

class helpjuice.api.group.Groups

Bases: helpjuice.api.schema.Collection

Group resource collection.

resource
get(*args, **kwargs)

Retrieve all groups.

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

Returns

helpjuice.api.Groups