Types do not match code about node-zendesk HOT 9 OPEN

node-zendesk version : 2.0.0 or 2.1.0
@types/node-zendesk 2.0.6
zendesk documentation : https://developer.zendesk.com/api-reference/ticketing/users/users/#show-user

from node-zendesk.

Also running into this issue!

from node-zendesk.

same issue on creating a ticket

from node-zendesk.

Running into this issue as well. If I modify the file: node_modules/node-zendesk/lib/client/client.js by commenting out / deleting lines 316-326 it works as expected with the types definition. (at least for the tickets api).

I'd prefer that the objects returned from the calls match the zendesk documentation (i.e. returning the parent object, rather than the child object).

Here is the commented out code that is causing the issue for reference of others dealing with this issue:
// if (self.jsonAPINames) {
// self.jsonAPINames.push("audit");
// self.jsonAPINames.push("via");
// for (var i = 0; i < self.jsonAPINames.length; i++) {
// if (res.hasOwnProperty(self.jsonAPINames[i].toString())) {
// body = res[self.jsonAPINames[i].toString()];
// break;
// }
// }
// }

from node-zendesk.

I'm facing the same issue.

I'm planning to use a similar solution to what @jase-k suggested, though wrap the node-zendesk client creation with my own function that will remove the jsonAPINames property from each of the APIs.

const createZendesk = (options: ClientOptions): zendesk.Client => {
  const client = zendesk.createClient(options)

  Object.keys(client).forEach((key) => {
    if (typeof client[key] === 'object' &&
      Object.prototype.hasOwnProperty.call(client[key], 'jsonAPINames')
    ) {
      delete client[key].jsonAPINames
    }
  })

  return client
}

from node-zendesk.