helpjuice.api.category
Helpjuice Categories API.
https://help.helpjuice.com/en_US/api-v3/api-v3#categories
Module Contents
Classes
Category resource. |
|
Category resource collection. |
- class helpjuice.api.category.Category
Bases:
helpjuice.api.schema.ResourceCategory 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
- post()
Create an category.
https://help.helpjuice.com/en_US/api-v3/api-v3#create-an-category
- Returns
- put()
Update an category.
https://help.helpjuice.com/en_US/api-v3/api-v3#update-an-category
- Returns
- delete()
Delete an category.
https://help.helpjuice.com/en_US/api-v3/api-v3#delete-an-category
- class helpjuice.api.category.Categories
Bases:
helpjuice.api.schema.CollectionCategory resource collection.
- resource
- get(*args, **kwargs)
Retrieve all categories.
https://help.helpjuice.com/en_US/api-v3/api-v3#retrieve-all-categories
- Returns