node-zendesk v5.0.0

🚀 Introducing node-zendesk v5.0.0: A Developer's Delight! 🚀

Hey Devs! We're super excited to roll out the major release of the node-zendesk library - version v5.0.0. This isn't just another release; it's a testament to our commitment to enhancing your developer experience.

🔍 Here's What's Cooking in v5.0.0:

• TypeScript Awesomeness: Dive into a strongly-typed world with our new TypeScript declaration files. Enjoy precise intellisense and fewer runtime errors. Thanks to @Coaktion for leading this!

• Refined Codebase: We've restructured the client codebase, making it more intuitive and modular. Navigate, extend, or integrate with ease.

• Docs That Empower: Our refreshed documentation is more than just a guide—it's your companion in building amazing things with node-zendesk.

• Blazing Fast Builds: With Esbuild under the hood, expect lightning-fast builds. Plus, our TypeScript declarations are now auto-generated, ensuring they're always in sync.

• Robust Testing: Sleep easy with our expanded test suite and mocks. Continuous integration via GitHub Actions means every commit is battle-tested.

• API Access Evolution: Note the shift - apiTypes like helpcenter are now accessed as client.helpcenter.resource.action(). It's more intuitive and aligns with modern API design patterns.

• Quality & Dependencies: With updated dependencies and rigorous linting, we've squashed those pesky bugs and polished the rough edges.

• Hats Off: A standing ovation for @onhate for the DX enhancements and @cryptomail for fortifying our tests with nock.

🌌 Join Our Galaxy of Supporters!
If node-zendesk fuels your projects, show some love with a ⭐ star on GitHub. Every star motivates us to push the DX boundaries further.

Dive deep into our commit history to witness our relentless pursuit of developer joy.

Cheers to crafting, debugging, and deploying with enhanced joy and efficiency! 🍻

node-zendesk v4.0.0

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, and nconf. As a result of removing nconf, 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:

• Introduced optional transportConfig to the Transporter class for HTTP client layer customization.
• Defaulted to native fetch(requires node 18) as the transport while maintaining a smooth fallback mechanism.
• Optional HTTP agnosticism -- New examples demonstrating integration**(optional)** with the request library (deprecated) and axios library.
• A fix to prevent unwanted slashes in URLs due to undefined or empty segments.

Requests Class Updates:

• Added a search method for querying specific ticket requests.
• Enhanced list methods with optional parameters for sort_by and sort_order.

Organization Related Enhancements:

• New methods: listByUser, count, countByUser, related, showMany, and bulkDelete.

Endpoint Enhancements:

• Introduced the EndpointChecker class for evaluating endpoint capabilities.
• Updated the URL assembly mechanism to include deep serialization of nested objects and improved assembleUrl function.
• Added support for CBP in the assembleUrl function.

Various Class & Method Additions:

• New methods for SLA policy reordering and filter definitions retrieval.
• Enhanced OrganizationFields and OrganizationMemberships.
• Extended the Locales class with new methods for Zendesk API.
• Additions and updates across various classes like Brands, Automations, Attachments, Activity Stream, and more.
• A new Transporter class, extracted from Client, now handles request logic.

Miscellaneous:

• Removed forums and forumsubscriptions endpoints as they're no longer in service.
• Several JSDoc additions and improvements across classes for better documentation.
• Refactoring of request methods for clarity and granularity.

Fixes:

• Fixed unwanted / being appended to URLs by filtering out undefined or empty string segments.
• Addressed URL formatting issues in assembleUrl.
• Resolved issue with CBP not being supported by default.
• Fixed remoteUri -> endpointUri issue.
• Remedied the issue with buggy exports.

Removed:

• Removed forums and forumsubscriptions - endpoints no longer in service.
• Removed unused API endpoint categories from the core.
• Deleted commented-out and unused parts of the code in various places.

Changed:

• Moved xo configuration into its separate file and excluded it from npm packaging.
• Moved documentation: rename doc -> old and then doc to docs.

Migration Procedure (if necessary):

1. Check Dependencies: Ensure that your current dependencies are compatible with the new changes, especially given the shift to native fetch in the Transporter class.
2. Update Custom Implementations: If you have custom implementations or overrides of the affected classes and methods, they might need adjustments to align with the updated methods.
3. Remove Deprecated Endpoints: If you're utilizing forums or forumsubscriptions, these have been removed and will need either replacement or removal in your application.
4. Test Extensively: Given the range of changes, it's crucial to test your application in a staging environment before deploying the updated package to production.

node-zendesk v3.0.2

We're excited to introduce node-zendesk v3.0.2, a release focused on enhancing your Zendesk API integration experience. This version brings notable improvements, bug fixes, and optimizations to ensure seamless performance.

Highlights

• Cursor-Based Pagination: This release introduces an innovative cursor-based pagination system, transforming the way you interact with the Zendesk API. Enjoy smoother navigation through results with enhanced efficiency. props to @cryptomail TYVM

• Bug Fixes: We've diligently addressed several reported issues to ensure a more reliable experience. Expect improved stability and reduced chances of unexpected behavior.

How to Upgrade

Updating to v3.0.2 is simple:

npm update node-zendesk

Documentation

For detailed information on using the new cursor-based pagination and leveraging the updated features, please refer to the issue that prompted this change here.

Feedback and Contributions

Your feedback is invaluable to us. If you encounter any issues or have suggestions for further improvements, please don't hesitate to open an issue on GitHub.

Thank you for being a part of the node-zendesk community. Your support drives our commitment to continuous enhancement and excellence.