rajeshgupta723
commented
6 months ago Hello @amadeogallardo , thank you for reaching out.
Migration documentation Moving from 4.0 to 4.1:
- Upgraded from Popsicle to Axios lib
- JSON.stringify(authResponse.getJson()) ==> should now been changed to JSON.stringify(authResponse.json)
-
Axios is not a drop-in replacement for Popsicle. Here are a few of the API differences:
Request config: Axios uses data instead of body. Axios.get() will override the the method option. There is no transport option. Response schema: Headers are turned into an object with lower cased names. Response data is atomically parsed and can be accessed with res.data. The response can't be stringified using JSON.stringify() because of res.request.
Breaking Change
Given the transport issue, this Migration does introduce a breaking change. e.g. Users that receive a PDF will have to change their code from this:
oauthClient.makeApiCall({
url: ${url}v3/company/${companyID}/invoice/${invoiceNumber}/pdf?minorversion=59,
headers:{'Content-Type': 'application/pdf','Accept':'application/pdf'},
transport: popsicle.createTransport({type: 'buffer'})
})
To this:
oauthClient.makeApiCall({
url: ${url}v3/company/${companyID}/invoice/${invoiceNumber}/pdf?minorversion=59,
headers:{'Content-Type': 'application/pdf','Accept':'application/pdf'},
responseType: 'arraybuffer'
})
@amadeogallardo May I request you to please validate the list of breaking changes that requires changes to the client codebase?
1) getJson function is now not available, while making the makeApiCall function. 2) thrown errors do not include an error object. For example, trying to use the /payment endpoints is failing after the upgrade, but this error can't be inspected because apparently the parameter is now not included.
amadeogallardo
Moving from 4.0 to 4.1 caused a number of issues related to the switch from Popsicle to Axios. Some of these have been fixed, but there's no documentation related to the upgrade path. For example, the
getJsonfunction is now not available, which could've been invoked by client code that used theagent.makeApiCallfunction.It also seems as if thrown errors do not include an
errorobject, which makes it really hard to troubleshoot what may have failed when performing a request. For example, trying to use the/paymentendpoints is failing after the upgrade, but I can't inspect the error because apparently the parameter is now not included.Overall, it seems as if 4.1 should've been 5.0 since it includes breaking changes that requires changes to the client codebase.
Is it possible to add some migration documentation between 4.0 and 4.1?