chore(deps): update dependency node-zendesk to v4 #1684
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^2.0.6 || ^3.0.0
->^2.0.6 || ^3.0.0 || ^4.0.0
Release Notes
blakmatrix/node-zendesk (node-zendesk)
v4.0.0
: node-zendesk v4.0.0Compare Source
Announcement: node-zendesk v4.0.0 Update 🚀
We're thrilled to announce a significant update to the Node-Zendesk package!
Notable Changes:
Dependencies Removed: We've removed the following dependencies -
request
,querystring
,async
, andnconf
. As a result of removingnconf
, command-line arguments will no longer work. However, these were buggy, so this change shouldn't affect the usage much. For configuration, you can now use dotenv. Refer to our examples for more clarity.Promises & Async/Await: Callbacks have been ditched in favor of promise or async/await patterns. If you need guidance on updating your code, check out the example here.
Accessing Side Loads: To access side loads, the format is now
client.<resource>.setSideLoad()
. Ensure you use this before calling any API endpoints and after client instantiation. For instance:client.users.setSideLoad(["roles","organizations"])
.For comprehensive details, the changelog is your best friend!
Documentation: A significant documentation update is on the horizon. Keep an eye on this issue for more information.
A colossal shout out to @teebot and @cryptomail for making this release possible! 🎉
Happy Coding!
Changelog
Added:
Transporter Class Enhancements:
transportConfig
to the Transporter class for HTTP client layer customization.node 18
) as the transport while maintaining a smooth fallback mechanism.Requests Class Updates:
search
method for querying specific ticket requests.list
methods with optional parameters forsort_by
andsort_order
.Organization Related Enhancements:
listByUser
,count
,countByUser
,related
,showMany
, andbulkDelete
.Endpoint Enhancements:
EndpointChecker
class for evaluating endpoint capabilities.assembleUrl
function.assembleUrl
function.Various Class & Method Additions:
OrganizationFields
andOrganizationMemberships
.Locales
class with new methods for Zendesk API.Brands
,Automations
,Attachments
,Activity Stream
, and more.Transporter
class, extracted fromClient
, now handles request logic.Miscellaneous:
forums
andforumsubscriptions
endpoints as they're no longer in service.Fixes:
/
being appended to URLs by filtering out undefined or empty string segments.assembleUrl
.remoteUri -> endpointUri
issue.Removed:
forums
andforumsubscriptions
- endpoints no longer in service.Changed:
xo
configuration into its separate file and excluded it from npm packaging.doc -> old
and thendoc
todocs
.Migration Procedure (if necessary):
Transporter
class.forums
orforumsubscriptions
, these have been removed and will need either replacement or removal in your application.v3.0.3
Compare Source
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.