node-zendesk

blakmatrixMIT更新放缓

面向 Node.js 和浏览器的 Zendesk API 客户端库,封装工单、知识库等客服接口,省去手写请求和鉴权逻辑。

A trusted Zendesk API client library for Node.js and the browser, lovingly maintained for over 10 years.

v6.0.1发布于 2024-12-20 02:14 UTC376star236fork同步于 2026-11-07 07:32 UTC

怎么上手

从 README 代码块原样提取,可能是其中一种安装方式
npm install --save node-zendesk
硬件要求

README 没有说明硬件要求。

下载:源码 zip·GitHub Releases(安装包)本站不镜像安装包

项目说明

这个项目的说明还在生成中,先参考下面「最近发版」和 README。

最近发版

5 个版本v6.0.1
  1. v6.0.1node-zendesk v6.0.1最新正式版2024-12-20 · 2024-12-20 02:14 UTC

    🚀 Release v6.0.1 – Token Obfuscation in Logs

    🔒 Security Enhancement

    • Tokens are now obfuscated in debug logs to prevent exposing sensitive information.
    • Tokens will appear as: abcde**********

    ⚠️ Breaking Change

    • If you rely on full tokens in plaintext logs, this change will affect you.

    📦 Update Instructions

    npm install node-zendesk@latest
    

    🙌 Thanks to the contributor @ngouy for this improvement!

  2. v5.0.15node-zendesk v5.0.152024-11-27 · 2024-11-27 01:37 UTC
    查看更新说明
    • Fixed: Corrected the response type for sideconversations.list to match the actual returned structure, ensuring proper TypeScript type definitions. (#435)
  3. v5.0.14node-zendesk v5.0.142024-11-27 · 2024-11-27 01:01 UTC

    这个版本没有写更新说明。

  4. v5.0.0node-zendesk v5.0.02023-10-10 · 2023-10-10 02:41 UTC
    查看更新说明

    🚀 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! 🍻

  5. v4.0.0node-zendesk v4.0.02023-09-13 · 2023-09-13 04:34 UTC
    查看更新说明

    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.
    • Replaced remoteUri with `endpointU

用户点评

登录用户的真实使用记录,可按版本和硬件筛选
共 0 条

    还没有人点评。第一个说出真实体验的人最有价值。

    README 原文

    未翻译

    node-zendesk logo

    npm

    node licenses PR's welcome XO code style

    Read the full documentation at blakmatrix.github.io/node-zendesk/

    Install

    To use the API, just do the standard

    npm install --save node-zendesk
    

    Example

    var zendesk = require('node-zendesk');
    // or `import {createClient} from 'node-zendesk'` if using typescript
    
    var client = zendesk.createClient({
      username:  'username',
      token:     'token',
      subdomain: 'subdomain'
    });
    
    client.users.list().then(users => {
      console.log('Total Users:', users.length);
      console.log('User Names:', users.map(user => user.name));
    }).catch(error => {
      console.error(`Failed to get list of users: ${error.message}`);
    });
    

    Take a look in the examples folder for more examples.

    Getting Started

    If you're new to node-zendesk, we recommend checking out our Getting Started Guide to help you set up and familiarize yourself with the library.

    Contributions

    If you're looking to contribute, please refer to the API Coverage Document, open an issue, or make a PR!

    Tests and examples are also welcome.

    Zendesk's documentation can be found here.

    🌟 Support Our Project!

    🎉 Join our community of supporters, backers, and sponsors to help fuel the growth and sustainability of our open-source project. Your contribution, no matter the size, makes a meaningful impact:

    • Supporters ($1/month): Even a small contribution helps us continue our mission. Every dollar adds up!
    • Backers ($5/month): Take your support up a notch and gain exclusive updates and features.
    • Sponsors ($100/month): Champion the project's progress, get prominent recognition, and shape its future.

    By becoming a supporter, backer, or sponsor, you're investing in the innovation and excellence of our project. Together, we can drive meaningful change and empower developers worldwide.

    🚀 Join Us | Learn More

    License

    MIT.