{"id":15957527,"url":"https://github.com/mamantoha/freshdesk_api_client_rb","last_synced_at":"2025-04-04T09:40:21.989Z","repository":{"id":29780716,"uuid":"33324778","full_name":"mamantoha/freshdesk_api_client_rb","owner":"mamantoha","description":"Unofficial Ruby Freshdesk API Client","archived":false,"fork":false,"pushed_at":"2018-05-22T08:41:34.000Z","size":38,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-15T23:16:34.813Z","etag":null,"topics":["api","freshdesk","ruby"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","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-04-02T18:24:31.000Z","updated_at":"2018-05-22T08:41:35.000Z","dependencies_parsed_at":"2022-07-26T04:18:22.241Z","dependency_job_id":null,"html_url":"https://github.com/mamantoha/freshdesk_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%2Ffreshdesk_api_client_rb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Ffreshdesk_api_client_rb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Ffreshdesk_api_client_rb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Ffreshdesk_api_client_rb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mamantoha","download_url":"https://codeload.github.com/mamantoha/freshdesk_api_client_rb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247157046,"owners_count":20893202,"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","freshdesk","ruby"],"created_at":"2024-10-07T13:41:58.434Z","updated_at":"2025-04-04T09:40:21.958Z","avatar_url":"https://github.com/mamantoha.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Freshdesk API Client\n\n[![Build Status][travis_badge]][travis]\n[![Gem Version][rubygems_badge]][rubygems]\n[![Code Climate][codeclimate_badge]][codeclimate]\n\nA Ruby API client that interfaces with freshdesk.com web service. This client supports regular CRUD operation.\n\nPlease see [API documentation](https://developers.freshdesk.com/api/) for more information.\n\nAs of now,it supports the following:\n\n* Solution Category\n* Solution Folder\n* Solution Article\n\nTo experiment with that code, run `bin/console` for an interactive prompt.\n\n## Installation\n\nThe Freshdesk API client can be installd using Bundler or Rubygems.\n\n### Bundler\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'freshdesk_api'\n```\n\nAnd then execute:\n\n```\n$ bundle\n```\n\n### Rubygems\n\nOr install it yourself as:\n\n```\n$ gem install freshdesk_api\n```\n\n## Configuration\n\nConfiguration is done through a block returning an instance of `FreshdeskAPI::Client`. The block is mandatory and if not passed, an `ArgumentError` will be thrown.\n\n```ruby\nrequire 'freshdesk_api'\n\nclient = FreshdeskAPI::Client.new do |config|\n  config.base_url = '\u003c- your-freshdesk-url -\u003e' # e.g. 'https://mydesk.freshdesk.com'\n  config.username = 'login.email@freshdesk.com'\n  config.password = 'your freshdesk password'\n\n  require 'logger'\n  config.logger = Logger.new(STDOUT)\nend\n```\n\nNote: This FreshdeskAPI API client only supports basic authentication at the moment.\n\n## Usage\n\nThe result of configuration is an instance of `FreshdeskAPI::Client` which can then be used in two different methods.\n\nOne way to use the client is to pass it in as an argument to individual classes.\n\n```ruby\nFreshdeskAPI::SolutionCategory.create!(client, name: 'API', description: 'API related documents')\nFreshdeskAPI::SolutionArticle.find!(client, id: 1, 1: category_id, folder_id: 1)\nFreshdeskAPI::SolutionFolder.update!(client, id: 1, category_id: 1, name: 'Folder API')\nFreshdeskAPI::SolutionArticle.destroy!(client, id: 1, category_id: 1, folder_id: 1)\n```\nAnother way is to use the instance methods under client.\n\n```ruby\ncategories = client.solution_categories\ncategory = categories.create!(name: 'API', description: 'API related documents')\ncategory.update!(name: 'API v2', description: 'API related documents v2')\ncategory = categories.find!(id: 1)\ncategory.destroy!\n```\n\nThe methods under `FreshdeskAPI::Client` (such as `.solution_categories`) return an instance of `FreshdeskAPI::Collection` a lazy-loaded list of that resource.\n\nActual requests may not be sent until an explicit `FreshdeskAPI::Collection#all!`.\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, update the version number in `version.rb`, and then 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 ( https://github.com/mamantoha/freshdesk_api_client_rb/fork )\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\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\nCopyright (c) 2015-2018 by Anton Maminov\n\n[travis_badge]: http://img.shields.io/travis/mamantoha/freshdesk_api_client_rb.svg?style=flat\n[travis]: https://travis-ci.org/mamantoha/freshdesk_api_client_rb\n\n[rubygems_badge]: http://img.shields.io/gem/v/freshdesk_api.svg?style=flat\n[rubygems]: https://rubygems.org/gems/freshdesk_api\n\n[codeclimate_badge]: http://img.shields.io/codeclimate/github/mamantoha/freshdesk_api_client_rb.svg?style=flat\n[codeclimate]: https://codeclimate.com/github/mamantoha/freshdesk_api_client_rb\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmamantoha%2Ffreshdesk_api_client_rb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmamantoha%2Ffreshdesk_api_client_rb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmamantoha%2Ffreshdesk_api_client_rb/lists"}