https://github.com/mamantoha/zendesk_help_center_api_client_rb
Zendesk Help Center REST API Client
https://github.com/mamantoha/zendesk_help_center_api_client_rb
api ruby zendesk
Last synced: about 1 year ago
JSON representation
Zendesk Help Center REST API Client
- Host: GitHub
- URL: https://github.com/mamantoha/zendesk_help_center_api_client_rb
- Owner: mamantoha
- License: apache-2.0
- Created: 2015-05-29T07:21:20.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2021-10-19T12:20:22.000Z (over 4 years ago)
- Last Synced: 2025-05-08T22:15:04.860Z (about 1 year ago)
- Topics: api, ruby, zendesk
- Language: Ruby
- Size: 23.4 KB
- Stars: 6
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zendesk HelpCenter API Client
This gem added support for [Zendesk Help Center](https://developer.zendesk.com/rest_api/docs/help_center/introduction) methods under [ZendeskAPI::Client](https://github.com/zendesk/zendesk_api_client_rb) gem.
To experiment with that code, run `bin/console` for an interactive prompt.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'zendesk_help_center_api'
```
And then execute:
```console
bundle
```
Or install it yourself as:
```console
gem install zendesk_help_center_api
```
## Usage
```ruby
require 'zendesk_api/help_center'
```
### Zendesk Client
```ruby
client = ZendeskAPI::Client.new do |config|
config.url = "<- your-zendesk-url ->" # e.g. https://mydesk.zendesk.com/api/v2
config.username = "login.email@zendesk.com"
config.password = "your zendesk password"
end
```
### Help Center
#### Categories
These endpoints only update category-level metadata such as the sorting position.
They don't update category translations.
```ruby
categories = client.hc_categories
category = categories.build(name: 'Test Category')
category.save
category.destroy
```
#### Sections
These endpoints only update section-level metadata such as the sorting position.
They don't update section translations.
See Translations.
```ruby
sections = category.sections
section = sections.first
```
#### Articles
Create Article:
```ruby
articles = section.articles
articles.build(title: 'Test Article')
```
Update Article:
These endpoints update article-level metadata such as its promotion status or sorting position.
The endpoints do not update translation properties such as the article's title, body, locale, or draft.
See Translations section.
```ruby
article = section.articles.first
article.update(position: 42)
article.save
```
### Help Center Translations
Translations represent the content in all supported languages of a `Help Center` item such as an `article` or a `section`. The default language is also included in the translations.
```ruby
categories_tr = category.translations
category_tr = categories_tr.build(locale: 'uk', title: 'Тестова Стаття', body: '')
category_tr.save
sections_tr = sections.translations
section_tr = article_tr.build(locale: 'uk', title: 'Це тест', body: '')
section_tr.save
articles_tr = article.translations
article_tr = article_translations.build(locale: 'uk', title: 'Тестова Стаття', body: '')
article_tr.save
article_tr = article.translations.select { |tr| tr.locale == "en-us" }.first
article_tr.update(title: "New Title", body: "New Body")
article_tr.save
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## License and Author
Copyright: 2015-2019 [Anton Maminov](anton.maminov@gmail.com)
This project is licensed under the Apache License, a copy of which can be found in the LICENSE file.