Build support api

.travis.yml

@@ -6,6 +6,7 @@ node_js:
 install:
   - npm install -g jest
   - npm install -g codecov
+  - yarn install
 
 script:
   - jest && codecov

README.md

@@ -1,33 +1,33 @@
 # @androozka/zendesk-api-js
 
-![travis_ci](https://travis-ci.org/androozka/zendesk-api-js.svg?branch=master)
+![npm](https://img.shields.io/npm/v/@androozka/zendesk-api-js)
+[![Build Status](https://travis-ci.com/androozka/zendesk-api-js.svg?branch=master)](https://travis-ci.com/androozka/zendesk-api-js)
 [![codecov](https://codecov.io/gh/androozka/zendesk-api-js/branch/master/graph/badge.svg)](https://codecov.io/gh/androozka/zendesk-api-js)
-![David](https://img.shields.io/david/androozka/zendesk-api-js)
+[![David](https://img.shields.io/david/androozka/zendesk-api-js)](https://david-dm.org/androozka/zendesk-api-js)
 [![install size](https://packagephobia.now.sh/badge?p=@androozka/zendesk-api-js)](https://packagephobia.now.sh/result?p=@androozka/zendesk-api-js)
 [![npm downloads](https://img.shields.io/npm/dt/@androozka/zendesk-api-js)](http://npm-stat.com/charts.html?package=@androozka/zendesk-api-js)
-![twitter follow](https://img.shields.io/twitter/follow/androozka?label=Follow&style=social)
+![Twitter Follow](https://img.shields.io/twitter/follow/androozka?label=Follow&style=social)
 
 A JS library for interacting with the Zendesk API.
 
 ## Features
 
-- Generates Zendesk API request objects
-- Send prepared object directly to axios
-- Mirrors Zendesk's API documentation
-- No dependencies
+- Generates Zendesk API request objects 😎
+- Send prepared object directly to axios 🤯
+- Mirrors [Zendesk's API documentation](https://developer.zendesk.com/rest_api/docs/zendesk-apis/resources) 👀
 
 ## Installing
 
 ### Using npm
 
 ```bash
-$ npm install @androozka/zendesk-api-js
+npm install @androozka/zendesk-api-js
 ```
 
 ### Using yarn
 
 ```bash
-$ yarn add @androozka/zendesk-api-js
+yarn add @androozka/zendesk-api-js
 ```
 
 ## Usage
@@ -78,49 +78,52 @@ const res = await axios(req);
 
 ### Support API
 
-- [x] Search
-- [ ] Users
+- [x] **Search**
+- [x] **Users**
+- [x] **Tickets**
+- [x] **Ticket Metrics**
+- [x] **Tags**
+
+#### Under Construction
+
+- [ ] Views
+- [ ] Organizations
+- [ ] Groups
+- [ ] Ticket Forms
+- [ ] Ticket Fields
+- [ ] User Fields
+- [ ] Organization Fields
+- [ ] Brands
 - [ ] User Identities
 - [ ] User Passwords
 - [ ] End Users
-- [ ] Groups
 - [ ] Group Memberships
 - [ ] Custom Agent Roles
-- [ ] Organizations
 - [ ] Organization Subscriptions
 - [ ] Organization Memberships
 - [ ] Requests
-- [x] Tickets
-- [ ] Ticket Import
-- [ ] Attachments
-- [ ] Satisfaction Ratings
-- [ ] Satisfaction Reasons
-- [ ] Suspended Tickets
 - [ ] Ticket Audits
 - [ ] Ticket Comments
 - [ ] Ticket Skips
-- [x] Ticket Metrics
 - [ ] Ticket Metric Events
 - [ ] Ticket Activities
+- [ ] Ticket Import
+- [ ] Attachments
+- [ ] Satisfaction Ratings
+- [ ] Satisfaction Reasons
+- [ ] Suspended Tickets
 - [ ] Sessions
-- [x] Tags
-- [ ] Views
 - [ ] Triggers
 - [ ] Automations
 - [ ] SLA Policies
 - [ ] Targets
 - [ ] Target Failures
 - [ ] Macros
-- [ ] Brands
 - [ ] Dynamic Content
 - [ ] Locales
 - [ ] Schedules
 - [ ] Sharing Agreements
 - [ ] Support Addresses
-- [ ] Ticket Forms
-- [ ] Ticket Fields
-- [ ] User Fields
-- [ ] Organization Fields
 - [ ] Job Statuses
 - [ ] Skill-based Routing
 - [ ] Incremental Skill-based Routing
@@ -140,7 +143,7 @@ const res = await axios(req);
 - [ ] Channel Framework
 - [ ] Twitter Channel
 
-### ToDo
+### APIs Up Next
 
 - Sunshine API
 - Help Center API

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@androozka/zendesk-api-js",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "A JS library for interacting with the Zendesk API.",
   "author": "Andrew Milenic <androozka@gmail.com>",
   "license": "MIT",
@@ -20,15 +20,15 @@
   ],
   "scripts": {
     "test": "jest",
-    "test:watch": "jest --watchAll --runInBand",
-    "pack": "npm pack",
-    "publish": "npm publish --access public"
+    "test:watch": "jest --watchAll --runInBand"
   },
   "files": [
     "index.js",
     "src/*"
   ],
-  "dependencies": {},
+  "dependencies": {
+    "@hapi/joi": "^15.1.1"
+  },
   "devDependencies": {
     "@types/jest": "^24.0.18",
     "eslint": "^6.2.1",

src/api/v2/routes/support/search.js

@@ -1,5 +1,17 @@
-module.exports = ({ instance, headers }) => ({ search_string }) => ({
-  method: 'GET',
-  url: `https://${instance}.zendesk.com/api/v2/search.json?query=${search_string}`,
-  headers
-});
+const validate = require('../../validators/support/search');
+
+module.exports = ({ instance, headers }) => {
+  const url = `https://${instance}.zendesk.com`;
+
+  return (options = {}) => {
+    const { error } = validate(options);
+    if (error) throw new Error(error.details[0].message);
+
+    const { search_string } = options;
+    return {
+      method: 'GET',
+      url: `${url}/api/v2/search.json?query=${search_string}`,
+      headers
+    };
+  };
+};

src/api/v2/routes/support/tags.js

@@ -1,56 +1,79 @@
-module.exports = ({ instance, headers }) => ({
-  list: () => ({
-    method: 'GET',
-    url: `https://${instance}.zendesk.com/api/v2/tags.json`,
-    headers
-  }),
-
-  show: ({ type, id }) => ({
-    method: 'GET',
-    url: {
-      tickets: `https://${instance}.zendesk.com/api/v2/tickets/${id}/tags.json`,
-      organizations: `https://${instance}.zendesk.com/api/v2/organizations/${id}/tags.json`,
-      users: `https://${instance}.zendesk.com/api/v2/users/${id}/tags.json`
-    }[type],
-    headers
-  }),
-
-  set: ({ type, id, data }) => ({
-    method: 'POST',
-    url: {
-      tickets: `https://${instance}.zendesk.com/api/v2/tickets/${id}/tags.json`,
-      organizations: `https://${instance}.zendesk.com/api/v2/organizations/${id}/tags.json`,
-      users: `https://${instance}.zendesk.com/api/v2/users/${id}/tags.json`
-    }[type],
-    headers,
-    data
-  }),
-
-  add: ({ type, id, data }) => ({
-    method: 'PUT',
-    url: {
-      tickets: `https://${instance}.zendesk.com/api/v2/tickets/${id}/tags.json`,
-      organizations: `https://${instance}.zendesk.com/api/v2/organizations/${id}/tags.json`,
-      users: `https://${instance}.zendesk.com/api/v2/users/${id}/tags.json`
-    }[type],
-    headers,
-    data
-  }),
-
-  remove: ({ type, id, data }) => ({
-    method: 'DELETE',
-    url: {
-      tickets: `https://${instance}.zendesk.com/api/v2/tickets/${id}/tags.json`,
-      organizations: `https://${instance}.zendesk.com/api/v2/organizations/${id}/tags.json`,
-      users: `https://${instance}.zendesk.com/api/v2/users/${id}/tags.json`
-    }[type],
-    headers,
-    data
-  }),
-
-  autocomplete: ({ name }) => ({
-    method: 'GET',
-    url: `https://${instance}.zendesk.com/api/v2/autocomplete/tags.json?name=${name}`,
-    headers
-  })
-});
+const validate = require('../../validators/support/tags');
+
+module.exports = ({ instance, headers }) => {
+  const url = `https://${instance}.zendesk.com`;
+
+  return {
+    list: (options = null) => {
+      if (options) throw new Error('no options are allowed');
+
+      return {
+        method: 'GET',
+        url: `${url}/api/v2/tags.json`,
+        headers
+      };
+    },
+
+    show: (options = {}) => {
+      const { error } = validate.show(options);
+      if (error) throw new Error(error.details[0].message);
+
+      const { type, id } = options;
+      return {
+        method: 'GET',
+        url: `${url}/api/v2/${type}/${id}/tags.json`,
+        headers
+      };
+    },
+
+    set: (options = {}) => {
+      const { error } = validate.set(options);
+      if (error) throw new Error(error.details[0].message);
+
+      const { type, id, data } = options;
+      return {
+        method: 'POST',
+        url: `${url}/api/v2/${type}/${id}/tags.json`,
+        headers,
+        data
+      };
+    },
+
+    add: (options = {}) => {
+      const { error } = validate.add(options);
+      if (error) throw new Error(error.details[0].message);
+
+      const { type, id, data } = options;
+      return {
+        method: 'PUT',
+        url: `${url}/api/v2/${type}/${id}/tags.json`,
+        headers,
+        data
+      };
+    },
+
+    remove: (options = {}) => {
+      const { error } = validate.remove(options);
+      if (error) throw new Error(error.details[0].message);
+
+      const { type, id } = options;
+      return {
+        method: 'DELETE',
+        url: `${url}/api/v2/${type}/${id}/tags.json`,
+        headers
+      };
+    },
+
+    autocomplete: (options = {}) => {
+      const { error } = validate.autocomplete(options);
+      if (error) throw new Error(error.details[0].message);
+
+      const { name } = options;
+      return {
+        method: 'GET',
+        url: `${url}/api/v2/autocomplete/tags.json?name=${name}`,
+        headers
+      };
+    }
+  };
+};

src/api/v2/routes/support/ticketMetrics.js

@@ -1,16 +1,38 @@
-module.exports = ({ instance, headers }) => ({
-  list: () => ({
-    method: 'GET',
-    url: `https://${instance}.zendesk.com/api/v2/ticket_metrics.json`,
-    headers
-  }),
+const validate = require('../../validators/support/ticketMetrics');
 
-  show: ({ type = 'default', ticket_metric_id, ticket_id }) => ({
-    method: 'GET',
-    url: {
-      default: `https://${instance}.zendesk.com/api/v2/ticket_metrics/${ticket_metric_id}.json`,
-      tickets: `https://${instance}.zendesk.com/api/v2/tickets/${ticket_id}/metrics.json`
-    }[type],
-    headers
-  })
-});
+module.exports = ({ instance, headers }) => {
+  const url = `https://${instance}.zendesk.com`;
+
+  return {
+    list: (options = null) => {
+      if (options) throw new Error('options not allowed');
+
+      return {
+        method: 'GET',
+        url: `${url}/api/v2/ticket_metrics.json`,
+        headers
+      };
+    },
+
+    show: (options = {}) => {
+      const { error } = validate.show(options);
+      if (error) throw new Error(error.details[0].message);
+
+      const { ticket_id = 0, ticket_metric_id = 0 } = options;
+      if ((!ticket_id && !ticket_metric_id) || (ticket_id && ticket_metric_id))
+        throw new Error(
+          'either "ticket_id" or "ticket_metric_id" must be set, but not both'
+        );
+
+      const part = ticket_id
+        ? `tickets/${ticket_id}/metrics.json`
+        : `ticket_metrics/${ticket_metric_id}.json`;
+
+      return {
+        method: 'GET',
+        url: `${url}/api/v2/${part}`,
+        headers
+      };
+    }
+  };
+};