Update Documentation and fix User and Org Fields #6
Conversation
physik932
added
documentation
| @@ -106,9 +78,14 @@ async function getContext() { | |||
| let { ticket } = await client.get('ticket'); | |||
| const ticketFields = await client.request(getTicketData(ticket.id)); | |||
|
|
|||
| if (ticket.organization) { | |||
There was a problem hiding this comment.
This is a conundrum. I checked both ZAFCient and Zendesk API for all the organizations, and of the 5 Organization objects returned, none of them had data in the organization_fields object. Furthermore, our User objects and Ticket object do not have organization data. I'm not sure why, or how this gets assigned. Either way, to protect ourselves from this, I have a null check for ticket.organization before trying to get the organization fields.
| return org.id = context.ticket.requester.organization_id; | ||
| }); | ||
| } | ||
| */ |
There was a problem hiding this comment.
Per this issue, I believe the organization fields are referred to incorrectly. The below code refers to the ticket's organization versus one of the requester organizations.
| }; | ||
| } | ||
|
|
||
| /** | ||
| * TODO: JS DOcs | ||
| */ | ||
| async function getContext() { | ||
| function buildContext(ticket, currentUser) { | ||
| async function buildContext(ticket, currentUser) { |
There was a problem hiding this comment.
async in an async doesn't read great. I wonder if we should pull buildContext out and place it above, like the processUserObject function. Although only the getContext function uses them, it might help readability.
| const [first_name = '', last_name = ''] = (user.name || '').split(' '); | ||
| async function processUserObject(user) { | ||
| const [firstName = '', lastName = ''] = (user.name || '').split(' '); | ||
| const { user: {user_fields}} = await client.request(getUserData(user.id)); |
There was a problem hiding this comment.
Destructuring a nested object.
| * | ||
| * @param {Object} user - A Zendesk User Object | ||
| */ | ||
| export function parseFirstLastName(user) { |
There was a problem hiding this comment.
We had this twice; this one being exported but not used anywhere else.
user_fieldsandorganization_fieldswork a bit differently thancustom_fields. To get the fields, I added two API calls to get the fields and destructure them into their appropriate objects.I also camelCased the currentUser, firstName and lastName fields in the documentation.