helpjuice.api

Submodules

• helpjuice.api.activity
• helpjuice.api.article
• helpjuice.api.category
• helpjuice.api.group
• helpjuice.api.schema
• helpjuice.api.search
• helpjuice.api.settings
• helpjuice.api.user

Package Contents

Classes

Activities	Activity resource collection.
Activity	Activity resource.
Article	Article resource.
Articles	Article resource collection.
Categories	Category resource collection.
Category	Category resource.
Group	Group resource.
Groups	Group resource collection.
Search	Search result resource collection.
Settings	Settings resource.
User	User
Users	User collection.

class helpjuice.api.Activities

Bases: helpjuice.api.schema.Collection

Activity resource collection.

resource

get(*args, **kwargs)

Retrieve all activities.

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

Returns

helpjuice.api.Activities

class helpjuice.api.Activity

Bases: helpjuice.api.schema.Resource

Activity resource.

id

Activity ID.

Type

int

trackable_id

Trackable resource ID.

Type

int

trackable_type

Trackable resource type.

Type

int

owner_id

Activity user ID.

Type

int

action

Activity performed.

Type

int

created_at

Timestamp activity was performed.

Type

int

get()

Retrieve an activity.

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

Returns

helpjuice.api.Activity

class helpjuice.api.Article

Bases: helpjuice.api.schema.Resource

Article resource.

id

Identifier of the article.

Type

int

name

Name of the article.

Type

str

description

Description of the article.

Type

str

codename

Slug or URL for the article.

Type

str

visibility_id

(public: 0, internal: 1, private: 2) Limited access to the article.

Type

int

body

Body of the article.

Type

str

published

Whether the article is published or not.

Type

bool

category_ids

Categories that the article will appear in.

Type

list

user_ids

If accessibility is set to private, these users will have access to it.

Type

list

group_ids

If accessibility is set to private, these group members will have access to it.

Type

list

contributor_user_ids

Article contributors.

Type

list

get()

Retrieve an article.

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

Returns

helpjuice.api.Article

post()

Create an article.

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

Returns

helpjuice.api.Article

put()

Update an article.

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

Returns

helpjuice.api.Article

delete()

Delete an article.

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

class helpjuice.api.Articles

Bases: helpjuice.api.schema.Collection

Article resource collection.

resource

get(*args, **kwargs)

Retrieve all articles.

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

Returns

helpjuice.api.Articles

class helpjuice.api.Categories

Bases: helpjuice.api.schema.Collection

Category resource collection.

resource

get(*args, **kwargs)

Retrieve all categories.

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

Returns

helpjuice.api.Categories

class helpjuice.api.Category

Bases: helpjuice.api.schema.Resource

Category resource.

parent_id

The ID of the parent category.

Type

int

accessibility

(public: 0, internal: 1, private: 2) Limited the access to articles inside.

Type

int

description

Description of the category.

Type

str

name

Name of the category.

Type

str

codename

The slug for the category.

Type

str

archived

Whether the category is archived or not.

Type

bool

user_ids

If accessibility is set to private, these users will have access to it.

Type

list

group_ids

If accessibility is set to private, these group members will have access to it.

Type

list

get()

Retrieve an category.

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

Returns

helpjuice.api.Category

post()

Create an category.

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

Returns

helpjuice.api.Category

put()

Update an category.

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

Returns

helpjuice.api.Category

delete()

Delete an category.

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

class helpjuice.api.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.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

class helpjuice.api.Search

Bases: helpjuice.api.schema.Collection

Search result resource collection.

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

resource

get(query, *args, **kwargs)

Search the Knowledge Base.

https://help.helpjuice.com/en_US/api-v3/api-v3#search-the-knowledge-base

Parameters

query (str) – Search query.

Returns

Search results.

Return type

helpjuice.api.Search

class helpjuice.api.Settings

Bases: helpjuice.api.schema.Resource

Settings resource.

name

Name of your account.

Type

str

subdomain

Name of your account in snake_case.

Type

str

top_questions_count

The number of articles that will be shown in your kb.

Type

int

internal_kb

Use your kb internally only.

Type

bool

expire_password_after_days

Password expiration for new users, number of days.

Type

int

contact_us_email

Support Email address.

Type

str

contact_us_subject

Contact us emails, subject line.

Type

str

contact_us_single_sender

Send all contact us emails asset in contact_us_email field.

Type

bool

only_internal_article_requests

Character encoding for requests and reports.

Type

bool

created_at

Account creation timestamp.

Type

str

get()

Retrieve account settings.

https://help.helpjuice.com/en_US/api-v3/api-v3#retrieve-account-settings

Returns

Account settings.

Return type

helpjuice.api.Settings

put()

Update account settings.

https://help.helpjuice.com/en_US/api-v3/api-v3#update-account-settings

Returns

Account settings.

Return type

helpjuice.api.Settings

class helpjuice.api.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.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