{"id":25585451,"url":"https://github.com/snkrheadz/freshdesk-ruby","last_synced_at":"2025-04-12T20:30:35.063Z","repository":{"id":52547292,"uuid":"87427031","full_name":"snkrheadz/freshdesk-ruby","owner":"snkrheadz","description":"A Ruby API client for Freshdesk API v2","archived":false,"fork":false,"pushed_at":"2020-08-17T17:56:51.000Z","size":10,"stargazers_count":6,"open_issues_count":7,"forks_count":18,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T14:50:07.984Z","etag":null,"topics":["freshdesk-api","ruby","ruby-gem"],"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/snkrheadz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-06T12:30:06.000Z","updated_at":"2021-11-08T11:16:48.000Z","dependencies_parsed_at":"2022-09-12T11:12:44.572Z","dependency_job_id":null,"html_url":"https://github.com/snkrheadz/freshdesk-ruby","commit_stats":null,"previous_names":["akinrt/freshdesk-ruby"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snkrheadz%2Ffreshdesk-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snkrheadz%2Ffreshdesk-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snkrheadz%2Ffreshdesk-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snkrheadz%2Ffreshdesk-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snkrheadz","download_url":"https://codeload.github.com/snkrheadz/freshdesk-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248629131,"owners_count":21136199,"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":["freshdesk-api","ruby","ruby-gem"],"created_at":"2025-02-21T07:17:09.927Z","updated_at":"2025-04-12T20:30:35.038Z","avatar_url":"https://github.com/snkrheadz.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# A Ruby API client for Freshdesk API v2\n\n[![Gem Version](https://badge.fury.io/rb/freshdesk-ruby.svg)](https://badge.fury.io/rb/freshdesk-ruby)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem \"freshdesk\"\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install freshdesk-ruby\n\n## Usage\n\nA Ruby API client that interfaces with freshdesk.com web service. This client supports regular CRUD operation\n\nIt supports following:\n\n- [Tickets](https://developer.freshdesk.com/api/#tickets)\n\n[freshdesk API reference](https://developer.freshdesk.com/api/)\n\nCurrently I needed this library to support Tickets APIs to use this api client on a project. I am gonna update with other API supports later. And collaborators are welcome :)\n\n```ruby\nrequire \"freshdesk\"\n\nFreshdesk.domain = \"replace with your domain\"\nFreshdesk.user_name_or_api_key = \"replace with your api key\"\nFreshdesk.password_or_x = \"X\"\n\n# creates a ticket\nparams = {\n  status: 2,\n  priority: 1,\n  description: \"test ticket creation with attachments\",\n  subject: \"new ticket sample #{Time.now}\",\n  cc_emails: [\"test+1@example.com\"],\n  email: \"test@example.com\",\n}\nFreshdesk::Ticket.create_a_ticket(params: params)\n\n# returns a ticket\nres = Freshdesk::Ticket.view_a_ticket(id: 19)\n# Freshdesk::Ticket.singleton_methods(false) return RestClient::Response instance\nres.class.name\n# =\u003e RestClient::Response\n\nres.code\n# =\u003e 200\n\nresponse_hash = JSON.parse(res.body)\n# =\u003e {\"cc_emails\"=\u003e[], \"fwd_emails\"=\u003e[], \"reply_cc_emails\"=\u003e[], \"fr_escalated\"=\u003efalse, \"spam\"=\u003efalse, \"email_config_id\"=\u003enil, \"group_id\"=\u003enil, \"priority\"=\u003e1, \"requester_id\"=\u003e27000314885, \"responder_id\"=\u003enil, \"source\"=\u003e2, \"company_id\"=\u003enil, \"status\"=\u003e2, \"subject\"=\u003e\"new ticket sample 2017-04-06 16:07:20 +0900\", \"to_emails\"=\u003enil, \"product_id\"=\u003enil, \"id\"=\u003e19, \"type\"=\u003enil, \"due_by\"=\u003e\"2017-05-26T09:00:00Z\", \"fr_due_by\"=\u003e\"2017-04-07T04:00:00Z\", \"is_escalated\"=\u003efalse, \"description\"=\u003e\"\u003cdiv\u003etest ticket creation with attachments\u003c/div\u003e\", \"description_text\"=\u003e\"test ticket creation with attachments\", \"custom_fields\"=\u003e{\"subcategory\"=\u003enil, \"category\"=\u003enil, \"featurecomponent\"=\u003enil, \"apiplugin\"=\u003enil, \"account_country\"=\u003enil, \"solution\"=\u003enil}, \"created_at\"=\u003e\"2017-04-06T06:06:42Z\", \"updated_at\"=\u003e\"2017-04-06T09:11:32Z\", \"tags\"=\u003e[], \"attachments\"=\u003e[]}\n\n# lists all tickets\nFreshdesk::Ticket.list_all_tickets\n\n# updates a ticket\nparams = {\n  subject: \"new ticket sample #{Time.now}\",\n}\nFreshdesk::Ticket.update_a_ticket(id: 19, params: params)\n\n# deletes a ticket\nFreshdesk::Ticket.delete_a_ticket(id: 19)\n\n# restores a ticket\nFreshdesk::Ticket.restore_a_ticket(id: 19)\n\n# lists all ticket fields\nFreshdesk::Ticket.list_all_ticket_fields\n\n# lists all conversations of a ticket\nFreshdesk::Ticket.list_all_conversations_of_a_ticket(id: 19)\n\n# lists all time entries of a ticket\nFreshdesk::Ticket.list_all_time_entries_of_a_ticket(id: 19)\n\n# lists all satisfaction ratings of a ticket\nFreshdesk::Ticket.list_all_satisfaction_ratings_of_a_ticket(ticket_id: 1)\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will 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\nBug reports and pull requests are welcome on GitHub at https://github.com/akinrt/freshdesk-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnkrheadz%2Ffreshdesk-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnkrheadz%2Ffreshdesk-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnkrheadz%2Ffreshdesk-ruby/lists"}