{"id":15698139,"url":"https://github.com/mamantoha/zendesk_help_center_api_client_rb","last_synced_at":"2025-05-08T22:15:10.984Z","repository":{"id":32893683,"uuid":"36488218","full_name":"mamantoha/zendesk_help_center_api_client_rb","owner":"mamantoha","description":"Zendesk Help Center REST API Client","archived":false,"fork":false,"pushed_at":"2021-10-19T12:20:22.000Z","size":24,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-08T22:15:04.860Z","etag":null,"topics":["api","ruby","zendesk"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"fluentassertions/fluentassertions","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mamantoha.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-29T07:21:20.000Z","updated_at":"2021-10-19T12:20:25.000Z","dependencies_parsed_at":"2022-08-07T18:16:02.131Z","dependency_job_id":null,"html_url":"https://github.com/mamantoha/zendesk_help_center_api_client_rb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Fzendesk_help_center_api_client_rb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Fzendesk_help_center_api_client_rb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Fzendesk_help_center_api_client_rb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Fzendesk_help_center_api_client_rb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mamantoha","download_url":"https://codeload.github.com/mamantoha/zendesk_help_center_api_client_rb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253154977,"owners_count":21862623,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","ruby","zendesk"],"created_at":"2024-10-03T19:23:34.549Z","updated_at":"2025-05-08T22:15:10.953Z","avatar_url":"https://github.com/mamantoha.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zendesk HelpCenter API Client\n\nThis 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.\n\nTo experiment with that code, run `bin/console` for an interactive prompt.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'zendesk_help_center_api'\n```\n\nAnd then execute:\n\n```console\nbundle\n```\n\nOr install it yourself as:\n\n```console\ngem install zendesk_help_center_api\n```\n\n## Usage\n\n```ruby\nrequire 'zendesk_api/help_center'\n```\n\n### Zendesk Client\n\n```ruby\nclient = ZendeskAPI::Client.new do |config|\n  config.url = \"\u003c- your-zendesk-url -\u003e\" # e.g. https://mydesk.zendesk.com/api/v2\n  config.username = \"login.email@zendesk.com\"\n  config.password = \"your zendesk password\"\nend\n```\n\n### Help Center\n\n#### Categories\n\nThese endpoints only update category-level metadata such as the sorting position.\nThey don't update category translations.\n\n```ruby\ncategories = client.hc_categories\ncategory = categories.build(name: 'Test Category')\ncategory.save\ncategory.destroy\n```\n\n#### Sections\n\nThese endpoints only update section-level metadata such as the sorting position.\nThey don't update section translations.\nSee Translations.\n\n```ruby\nsections = category.sections\nsection = sections.first\n```\n\n#### Articles\n\nCreate Article:\n\n```ruby\narticles = section.articles\narticles.build(title: 'Test Article')\n```\n\nUpdate Article:\n\nThese endpoints update article-level metadata such as its promotion status or sorting position.\nThe endpoints do not update translation properties such as the article's title, body, locale, or draft.\nSee Translations section.\n\n```ruby\narticle = section.articles.first\narticle.update(position: 42)\narticle.save\n```\n\n### Help Center Translations\n\nTranslations 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.\n\n```ruby\ncategories_tr = category.translations\ncategory_tr = categories_tr.build(locale: 'uk', title: 'Тестова Стаття', body: '')\ncategory_tr.save\n\nsections_tr = sections.translations\nsection_tr = article_tr.build(locale: 'uk', title: 'Це тест', body: '')\nsection_tr.save\n\narticles_tr = article.translations\narticle_tr = article_translations.build(locale: 'uk', title: 'Тестова Стаття', body: '')\narticle_tr.save\n\narticle_tr = article.translations.select { |tr| tr.locale == \"en-us\" }.first\narticle_tr.update(title: \"New Title\", body: \"New Body\")\narticle_tr.save\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo 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).\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/mamantoha/zendesk_help_center_api_client_rb/fork\u003e)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## License and Author\n\nCopyright: 2015-2019 [Anton Maminov](anton.maminov@gmail.com)\n\nThis project is licensed under the Apache License, a copy of which can be found in the LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmamantoha%2Fzendesk_help_center_api_client_rb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmamantoha%2Fzendesk_help_center_api_client_rb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmamantoha%2Fzendesk_help_center_api_client_rb/lists"}