| 1 | # @androozka/zendesk-api-js
|
| 2 |
|
| 3 | 
|
| 4 | [](https://travis-ci.com/androozka/zendesk-api-js)
|
| 5 | [](https://codecov.io/gh/androozka/zendesk-api-js)
|
| 6 | [](https://david-dm.org/androozka/zendesk-api-js)
|
| 7 | [](https://packagephobia.now.sh/result?p=@androozka/zendesk-api-js)
|
| 8 | [](http://npm-stat.com/charts.html?package=@androozka/zendesk-api-js)
|
| 9 | 
|
| 10 |
|
| 11 | A JS library for interacting with the Zendesk API.
|
| 12 |
|
| 13 | ## Features
|
| 14 |
|
| 15 | - Generates Zendesk API request objects 😎
|
| 16 | - Send prepared object directly to axios 🤯
|
| 17 | - Mirrors [Zendesk's API documentation](https://developer.zendesk.com/rest_api/docs/zendesk-apis/resources) 👀
|
| 18 |
|
| 19 | _**Note**: Only v2 framework, [v1 deprecated](https://support.zendesk.com/hc/en-us/articles/360002106888-Removal-of-Zendesk-Apps-framework-v1)_
|
| 20 |
|
| 21 | ## Installing
|
| 22 |
|
| 23 | ```bash
|
| 24 | # using npm
|
| 25 | npm install @androozka/zendesk-api-js
|
| 26 |
|
| 27 | # using yarn
|
| 28 | yarn add @androozka/zendesk-api-js
|
| 29 | ```
|
| 30 |
|
| 31 | ## Usage
|
| 32 |
|
| 33 | ### Getting Started
|
| 34 |
|
| 35 | ```javascript
|
| 36 | const axios = require('axios'); // Suggested library
|
| 37 | const zdApi = require('@androozka/zendesk-api-js');
|
| 38 | ```
|
| 39 |
|
| 40 | ### Zendesk Info
|
| 41 |
|
| 42 | ```javascript
|
| 43 | const options = {
|
| 44 | instance: '', // Zendesk subdomain
|
| 45 | email: '', // User account to perform requests
|
| 46 | password: '', // Password for user account
|
| 47 | token: '' // Generated Zendesk token
|
| 48 | };
|
| 49 | /* Note: Either "password" or "token" is required */
|
| 50 | ```
|
| 51 |
|
| 52 | ### Initalize
|
| 53 |
|
| 54 | ```javascript
|
| 55 | // Load entire library
|
| 56 | const { support, sunshine } = zdApi.init(options);
|
| 57 |
|
| 58 | // Load entire API
|
| 59 | const { tickets, groups } = zdApi.support.init(options);
|
| 60 |
|
| 61 | // Load specific endpoint
|
| 62 | const { list, create } = zdApi.support.tickets(options);
|
| 63 | ```
|
| 64 |
|
| 65 | ## Examples
|
| 66 |
|
| 67 | ### Add tags to a ticket
|
| 68 |
|
| 69 | ```javascript
|
| 70 | try {
|
| 71 | const { tags } = zdApi.support.init(options);
|
| 72 | const data = { tags: ['tag_1', 'tag_2', ... ] }
|
| 73 |
|
| 74 | const req = tags.add({ type: 'tickets', id: 123, data });
|
| 75 |
|
| 76 | const res = await axios(req);
|
| 77 | } catch (error) {
|
| 78 | // ...
|
| 79 | }
|
| 80 | ```
|
| 81 |
|
| 82 | ## API Coverage Status
|
| 83 |
|
| 84 | ### Support API
|
| 85 |
|
| 86 | Search, Users, End Users, Groups, Group Memberships, Custom Agent Roles, Organizations, Organization Subscriptions, Organization Memberships, Tickets, Ticket Import, Satisfaction Ratings, Satisfaction Reasons, Suspended Tickets, Ticket Audits, Ticket Comments, Ticket Skips, Ticket Metrics, Ticket Metric Events, Ticket Activities, Tags, Views, Brands, Sharing Agreements, Support Addresses, Ticket Forms, Ticket Fields, User Fields, Organization Fields, Job Statuses, Incremental Skill-based Routing, Workspaces, App Installation Locations, Account Settings, Audit Logs, Twitter Channel
|
| 87 |
|
| 88 | ### Sunshine API
|
| 89 |
|
| 90 | Custom Object Types, Custom Object Records, Relationship Types, Relationship Records, Custom Objects Events
|
| 91 |
|
| 92 | ### Under Construction
|
| 93 |
|
| 94 | #### Support
|
| 95 |
|
| 96 | - [ ] User Identities
|
| 97 | - [ ] User Passwords
|
| 98 | - [ ] Requests
|
| 99 | - [ ] Attachments
|
| 100 | - [ ] Sessions
|
| 101 | - [ ] Triggers
|
| 102 | - [ ] Automations
|
| 103 | - [ ] SLA Policies
|
| 104 | - [ ] Targets
|
| 105 | - [ ] Target Failures
|
| 106 | - [ ] Macros
|
| 107 | - [ ] Dynamic Content
|
| 108 | - [ ] Locales
|
| 109 | - [ ] Schedules
|
| 110 | - [ ] Skill-based Routing
|
| 111 | - [ ] Apps
|
| 112 | - [ ] App Locations
|
| 113 | - [ ] OAuth Clients
|
| 114 | - [ ] OAuth Tokens
|
| 115 | - [ ] OAuth Tokens for Grant Types
|
| 116 | - [ ] Authorized Global Clients
|
| 117 | - [ ] Bookmarks
|
| 118 | - [ ] Push Notification Devices
|
| 119 | - [ ] Resource Collections
|
| 120 | - [ ] Channel Framework
|
| 121 |
|
| 122 | #### Sunshine
|
| 123 |
|
| 124 | - [ ] Jobs
|
| 125 | - [ ] Limits
|
| 126 | - [ ] Events
|
| 127 | - [ ] Profiles
|
| 128 | - [ ] People
|
| 129 |
|
| 130 | ### APIs Up Next
|
| 131 |
|
| 132 | - Help Center API
|
| 133 | - Chat API
|
| 134 | - Talk API
|
| 135 | - Sell API
|
| 136 | - Answer Bot API
|
| 137 | - Status API
|
| 138 | - Reseller API
|
| 139 | - NPS API
|