{"id":16640776,"url":"https://github.com/shdblowers/zendex","last_synced_at":"2025-10-30T09:31:34.568Z","repository":{"id":57558441,"uuid":"67488819","full_name":"shdblowers/zendex","owner":"shdblowers","description":"An Elixir wrapper for the Zendesk API.","archived":false,"fork":false,"pushed_at":"2017-01-25T16:50:34.000Z","size":60,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-09-23T03:52:23.460Z","etag":null,"topics":["elixir","zendesk","zendesk-api"],"latest_commit_sha":null,"homepage":"","language":"Elixir","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/shdblowers.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":"2016-09-06T08:24:58.000Z","updated_at":"2017-03-05T23:50:42.000Z","dependencies_parsed_at":"2022-08-28T09:32:24.418Z","dependency_job_id":null,"html_url":"https://github.com/shdblowers/zendex","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/shdblowers%2Fzendex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shdblowers%2Fzendex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shdblowers%2Fzendex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shdblowers%2Fzendex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shdblowers","download_url":"https://codeload.github.com/shdblowers/zendex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219856466,"owners_count":16556082,"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":["elixir","zendesk","zendesk-api"],"created_at":"2024-10-12T07:25:38.273Z","updated_at":"2025-10-30T09:31:34.186Z","avatar_url":"https://github.com/shdblowers.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zendex\n[![Build Status](https://travis-ci.org/shdblowers/zendex.svg?branch=master)](https://travis-ci.org/shdblowers/zendex)\n[![Coverage Status](https://coveralls.io/repos/github/shdblowers/zendex/badge.svg?branch=master)](https://coveralls.io/github/shdblowers/zendex?branch=master)\n[![Ebert](https://ebertapp.io/github/shdblowers/zendex.svg)](https://ebertapp.io/github/shdblowers/zendex)\n[![Hex.pm version](http://img.shields.io/hexpm/v/zendex.svg?style=flat)](https://hex.pm/packages/zendex)\n[![Hex.pm downloads](https://img.shields.io/hexpm/dt/zendex.svg?style=flat)](https://hex.pm/packages/zendex)\n[![Hex.pm license](https://img.shields.io/hexpm/l/zendex.svg?style=flat)](https://github.com/shdblowers/zendex/blob/master/LICENSE)\n[![Libraries.io dependencies](https://img.shields.io/librariesio/release/hex/zendex.svg?style=flat)](https://libraries.io/hex/zendex)\n\nAn Elixir wrapper for the Zendesk API.\n\n[ExDoc Documentation](https://hexdocs.pm/zendex)  \n\n## Installation\n\n  1. Add `zendex` to your list of dependencies in `mix.exs`:\n\n    ```elixir\n    def deps do\n      [{:zendex, \"~\u003e 0.8.1\"}]\n    end\n    ```\n\n  2. Ensure `zendex` is started before your application:\n\n    ```elixir\n    def application do\n      [applications: [:zendex]]\n    end\n    ```\n\n## Usage\n\n  1. Setup a `Zendex.Connection` map, that will store your Zendesk details. It requires the URL of your Zendesk instance, your username and your password.\n\n  ```elixir\n  iex\u003e conn = Zendex.Connection.setup(\"http://test.zendesk.com\", \"User1\", \"pass\")\n  %{authentication: \"VXNlcjE6cGFzcw==\", base_url: \"http://test.zendesk.com\"}\n  ```\n\n  2. Make use of the other modules to do various actions on your Zendesk. Example of showing a user:\n\n  ```elixir\n  iex\u003e Zendex.User.show(conn, 1)\n  %{\"user\": %{\"id\": 87, \"name\": \"Quim Stroud\", ...}}\n  ```\n\n  3. Using pipes:\n\n  ```elixir\n  \"http://test.zendesk.com\"\n  |\u003e Zendex.Connection.setup(\"Username1\", \"password123\")\n  |\u003e Zendex.User.show(101)\n  ```\n\n## Completeness and Contributions\n\nThis package far from complete in terms of utilising all of the Zendesk API, any contributions will be welcome. Please keep the code consistent with what I have already written here.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshdblowers%2Fzendex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshdblowers%2Fzendex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshdblowers%2Fzendex/lists"}