| 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 | ## Installing
|
| 20 |
|
| 21 | ### Using npm
|
| 22 |
|
| 23 | ```bash
|
| 24 | npm install @androozka/zendesk-api-js
|
| 25 | ```
|
| 26 |
|
| 27 | ### Using yarn
|
| 28 |
|
| 29 | ```bash
|
| 30 | yarn add @androozka/zendesk-api-js
|
| 31 | ```
|
| 32 |
|
| 33 | ## Usage
|
| 34 |
|
| 35 | ### Suggested libraries
|
| 36 |
|
| 37 | ```javascript
|
| 38 | const base64 = require('js-base64').Base64;
|
| 39 | const axios = require('axios');
|
| 40 | ```
|
| 41 |
|
| 42 | ### Zendesk account information
|
| 43 |
|
| 44 | ```javascript
|
| 45 | const instance = ''; // Name of Zendesk instance
|
| 46 | const email = ''; // Email address of Zendesk user
|
| 47 | const token = ''; // Generated Zendesk token
|
| 48 |
|
| 49 | const encoded = base64.encode(`${email}/token:${token}`);
|
| 50 |
|
| 51 | const headers = {
|
| 52 | 'Content-Type': 'application/json',
|
| 53 | Authorization: `Basic ${encoded}`
|
| 54 | };
|
| 55 | ```
|
| 56 |
|
| 57 | ### Choose framework version
|
| 58 |
|
| 59 | ```javascript
|
| 60 | const zdApi = require('@androozka/zendesk-api-js');
|
| 61 | const zaf_v2 = zdApi.v2({ instance, headers });
|
| 62 | ```
|
| 63 |
|
| 64 | - _**Note**: Only v2, [v1 being deprecated](https://support.zendesk.com/hc/en-us/articles/360002106888-Removal-of-Zendesk-Apps-framework-v1)_
|
| 65 |
|
| 66 | ### Selecting API endpoints
|
| 67 |
|
| 68 | ```javascript
|
| 69 | const { support, sunshine } = zaf_v2;
|
| 70 | ```
|
| 71 |
|
| 72 | ## Examples
|
| 73 |
|
| 74 | ### Add tags to a ticket
|
| 75 |
|
| 76 | ```javascript
|
| 77 | try {
|
| 78 | const data = { tags: ['tag_1', 'tag_2', ... ] }
|
| 79 | const req = support.tags.add({ type: 'tickets', id: 123, data });
|
| 80 | const res = await axios(req);
|
| 81 | } catch (error) {
|
| 82 | // ...
|
| 83 | }
|
| 84 | ```
|
| 85 |
|
| 86 | ## API Coverage Status
|
| 87 |
|
| 88 | ### Support API
|
| 89 |
|
| 90 | Search, Users, End Users, Groups, Organizations, Tickets, Ticket Comments, Ticket Metrics, Ticket Activities, Tags, Views, Ticket Forms, Ticket Fields, User Fields, Organization Fields
|
| 91 |
|
| 92 | #### Under Construction
|
| 93 |
|
| 94 | - [ ] Brands
|
| 95 | - [ ] User Identities
|
| 96 | - [ ] User Passwords
|
| 97 | - [ ] Group Memberships
|
| 98 | - [ ] Custom Agent Roles
|
| 99 | - [ ] Organization Subscriptions
|
| 100 | - [ ] Organization Memberships
|
| 101 | - [ ] Requests
|
| 102 | - [ ] Ticket Audits
|
| 103 | - [ ] Ticket Skips
|
| 104 | - [ ] Ticket Metric Events
|
| 105 | - [ ] Ticket Import
|
| 106 | - [ ] Attachments
|
| 107 | - [ ] Satisfaction Ratings
|
| 108 | - [ ] Satisfaction Reasons
|
| 109 | - [ ] Suspended Tickets
|
| 110 | - [ ] Sessions
|
| 111 | - [ ] Triggers
|
| 112 | - [ ] Automations
|
| 113 | - [ ] SLA Policies
|
| 114 | - [ ] Targets
|
| 115 | - [ ] Target Failures
|
| 116 | - [ ] Macros
|
| 117 | - [ ] Dynamic Content
|
| 118 | - [ ] Locales
|
| 119 | - [ ] Schedules
|
| 120 | - [ ] Sharing Agreements
|
| 121 | - [ ] Support Addresses
|
| 122 | - [ ] Job Statuses
|
| 123 | - [ ] Skill-based Routing
|
| 124 | - [ ] Incremental Skill-based Routing
|
| 125 | - [ ] Workspaces
|
| 126 | - [ ] Apps
|
| 127 | - [ ] App Installation Locations
|
| 128 | - [ ] App Locations
|
| 129 | - [ ] OAuth Clients
|
| 130 | - [ ] OAuth Tokens
|
| 131 | - [ ] OAuth Tokens for Grant Types
|
| 132 | - [ ] Authorized Global Clients
|
| 133 | - [ ] Account Settings
|
| 134 | - [ ] Audit Logs
|
| 135 | - [ ] Bookmarks
|
| 136 | - [ ] Push Notification Devices
|
| 137 | - [ ] Resource Collections
|
| 138 | - [ ] Channel Framework
|
| 139 | - [ ] Twitter Channel
|
| 140 |
|
| 141 | ### APIs Up Next
|
| 142 |
|
| 143 | - Sunshine API
|
| 144 | - Help Center API
|
| 145 | - Chat API
|
| 146 | - Talk API
|
| 147 | - Sell API
|
| 148 | - Answer Bot API
|
| 149 | - Status API
|
| 150 | - Reseller API
|
| 151 | - NPS API
|