UNPKG

3.61 kBJavaScriptView Raw
1const Joi = require('@hapi/joi');
2const { validate, prepare } = require('../../utils/options');
3
4// Validation
5const _id = Joi.number().positive();
6const _data = Joi.object();
7
8// Initialize Endpoint
9module.exports = (options = {}) => {
10 const { error } = validate(options);
11 if (error) throw new Error(error.details[0].message);
12
13 const { url, headers } = prepare(options);
14
15 return {
16 /**
17 * List Support Addresses
18 *
19 * GET /api/v2/recipient_addresses.json
20 * https://developer.zendesk.com/rest_api/docs/support/support_addresses#list-support-addresses
21 */
22 list: () => {
23 // Ignore any options
24 return {
25 method: 'GET',
26 url: `${url}/api/v2/recipient_addresses.json`,
27 headers
28 };
29 },
30
31 /**
32 * Show Support Address
33 *
34 * GET /api/v2/recipient_addresses/{id}.json
35 * https://developer.zendesk.com/rest_api/docs/support/support_addresses#show-support-address
36 */
37 show: (options = {}) => {
38 const { error } = Joi.object({
39 id: _id.required()
40 }).validate(options);
41 if (error) throw new Error(error.details[0].message);
42
43 const { id } = options;
44 return {
45 method: 'GET',
46 url: `${url}/api/v2/recipient_addresses/${id}.json`,
47 headers
48 };
49 },
50
51 /**
52 * Create Support Address
53 *
54 * POST /api/v2/recipient_addresses.json
55 * https://developer.zendesk.com/rest_api/docs/support/support_addresses#create-support-address
56 */
57 create: (options = {}) => {
58 const { error } = Joi.object({
59 data: _data.required()
60 }).validate(options);
61 if (error) throw new Error(error.details[0].message);
62
63 const { data } = options;
64 return {
65 method: 'POST',
66 url: `${url}/api/v2/recipient_addresses.json`,
67 headers,
68 data
69 };
70 },
71
72 /**
73 * Update Support Address
74 *
75 * PUT /api/v2/recipient_addresses/{id}.json
76 * https://developer.zendesk.com/rest_api/docs/support/support_addresses#update-support-address
77 */
78 update: (options = {}) => {
79 const { error } = Joi.object({
80 id: _id.required(),
81 data: _data.required()
82 }).validate(options);
83 if (error) throw new Error(error.details[0].message);
84
85 const { id, data } = options;
86 return {
87 method: 'PUT',
88 url: `${url}/api/v2/recipient_addresses/${id}.json`,
89 headers,
90 data
91 };
92 },
93
94 /**
95 * Verify Support Address Forwarding
96 *
97 * PUT /api/v2/recipient_addresses/{id}/verify.json
98 * https://developer.zendesk.com/rest_api/docs/support/support_addresses#verify-support-address-forwarding
99 */
100 verify: (options = {}) => {
101 const { error } = Joi.object({
102 id: _id.required()
103 }).validate(options);
104 if (error) throw new Error(error.details[0].message);
105
106 const { id } = options;
107 return {
108 method: 'PUT',
109 url: `${url}/api/v2/recipient_addresses/${id}/verify.json`,
110 headers
111 };
112 },
113
114 /**
115 * Delete Recipient Address
116 *
117 * DELETE /api/v2/recipient_addresses/{id}.json
118 * https://developer.zendesk.com/rest_api/docs/support/support_addresses#delete-recipient-address
119 */
120 delete: (options = {}) => {
121 const { error } = Joi.object({
122 id: _id.required()
123 }).validate(options);
124 if (error) throw new Error(error.details[0].message);
125
126 const { id } = options;
127 return {
128 method: 'DELETE',
129 url: `${url}/api/v2/recipient_addresses/${id}.json`,
130 headers
131 };
132 }
133 };
134};