Joshlha / reified-client-api

Typescript wrapper API for ZAFClient
https://www.npmjs.com/package/reified-client-api
MIT License
9 stars 1 forks source link

Callback functions for change events are missing parameter types #11

Open Joshlha opened 1 month ago

Joshlha commented 1 month ago

Unfortunately, callback functions for ticket change events do not have their types specified in the documentation, but it is very likely that most events provide some sort of data to their callback function.

One example is that of the ticket.conversation.changed event, which fires when a new comment is added.

The callback function is passed the ticket's new conversation data, which includes all comments.

The list of change events for the ticket can be found here.

This will take some work to effectively test these functions, log their parameter data, and figure out what data type is being passed to the function.

We will have to update the type in lib/support.ts.