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