re·i·fy
/ˈrēəˌfī/
verb formal
make (something abstract) more concrete or real
"these instincts are, in humans, reified as verbal constructs"
A typescript API to help Zendesk app developers with creating type-safe projects.
No more typos - the full ZAFClient API is available via type-safe paths to the objects, events, or actions you wish to access.
No more passing in the string you just gave the ZAFClient to get the actual object.
// Old syntax
const ticketObject = (await client.get("ticket"))["ticket"]
// New syntax
const ticketObject = await client.get(Support.TicketSidebar.Objects.ticket)
The API is broken up first by Zendesk API, then by app location, then by path type (Event, Object, Action).
const ticket = await client.get(Support.TicketSidebar.Objects.ticket) // Returns object of type Ticket
console.log(ticket.assignee)
/*
{
user: { /* user object */ },
group: { /* group object */ }
}
*/
client.on(Core.Events.app.registered, (appData: any) => {
// do stuff
})
client.invoke(Support.TicketSidebar.Actions.ticketFields(2).enable)
The custom_field
path is only available for a few zendesk objects, such as ticket or user.
custom_field
before the invokationcustom_field
callable object will return a type of unknown
by default. You must specify the type via a type parameter or by casting.
const customUserField = await client.get(Support.UserSidebar.Objects.user.custom_field!<string>("CustomFieldID"))
// or
const customUserField = await client.get(Support.UserSidebar.Objects.user.custom_field!("CustomFieldID")) as string
You can get individual elements of indexable objects and properties via their callable object paths and passing in either an integer or string. Refer to the ZAFClient api for which to use. Most indexables can take either an integer index or a string ID.
const firstGroupNameOfSecondCommentAuthor = await client.get(Support.TicketSidebar.Objects.ticket.comments(2).author.groups(1).name)
The API also supports the "bulk" get function, though you will need to index into the returned object to get the actual object.
Conveniently, you can use the _path
property to get the underlying string value which is passed to the client. Putting it all together would look like this.
const objsToGet = [
Support.TicketSidebar.Objects.ticket.comment,
Support.Common.Objects.currentUser
]
const returnedObj = await client.get(objsToGet) // type: { [key: string]: any }
// Comment and User interfaces are available for import, along with many others
const commentObj = returnedObj[objsToGet[0]._path] as Comment
const userObj = returnedObj[objsToGet[1]._path] as User
If you don't have a typescript project set up, see this scaffold for a Zendesk app written in Typescript
npm i reified-client-api
ZAFClient
as a known const
in your app's entrypoint.
declare const ZAFClient: any;
ReifiedClient
by passing in the client instance
const client = new ReifiedClient(ZAFClient.init())
Since types are only implemented for the Support
and Core
APIs, there is still work to be done to implement the other APIs.
Types representing actual Zendesk objects or functions which are returned from or passed to API calls are kept in lib/zendesk_types
. The actual API, along with the helper types and functions that make it work, are simply in lib/
and currently contains the Core
and Support
APIs.
Contributions of any kind (additional API support, polish to existing APIs, test files) are welcome.
This is not an official Inductive Automation product and is not affiliated with, supported by, maintained by, or otherwise associated with Inductive Automation in any way. This software is provided as-is with no warranty.