Nutritious Pumpkin Mash

    @androozka/zendesk-api-js

    2.0.1 • Public • Published

    @androozka/zendesk-api-js

    npm Travis (.com) codecov David install size npm downloads Twitter Follow

    A JS library for interacting with the Zendesk API.

    Features

    Note: Only v2 framework, v1 deprecated

    Installing

    # using npm
    npm install @androozka/zendesk-api-js
    
    # using yarn
    yarn add @androozka/zendesk-api-js

    Usage

    Getting Started

    const axios = require('axios'); // Suggested library
    const zdApi = require('@androozka/zendesk-api-js');

    Zendesk Info

    const options = {
      instance: '', // Zendesk subdomain
      email: '', // User account to perform requests
      password: '', // Password for user account
      token: '' // Generated Zendesk token
    };
    /* Note: Either "password" or "token" is required */

    Initalize

    // Load entire library
    const { support, sunshine } = zdApi.init(options);
    
    // Load entire API
    const { tickets, groups } = zdApi.support.init(options);
    
    // Load specific endpoint
    const { list, create } = zdApi.support.tickets(options);

    Examples

    Add tags to a ticket

    try {
      const { tags } = zdApi.support.init(options);
      const data = { tags: ['tag_1', 'tag_2', ... ] }
    
      const req = tags.add({ type: 'tickets', id: 123, data });
    
      const res = await axios(req);
    } catch (error) {
      // ...
    }

    API Coverage Status

    Support API

    Search, Users, End Users, Groups, Group Memberships, Custom Agent Roles, Organizations, Organization Subscriptions, Organization Memberships, Tickets, Ticket Import, Satisfaction Ratings, Satisfaction Reasons, Suspended Tickets, Ticket Audits, Ticket Comments, Ticket Skips, Ticket Metrics, Ticket Activities, Tags, Views, Ticket Forms, Ticket Fields, User Fields, Organization Fields, Job Statuses, Audit Logs

    Sunshine API

    Custom Object Types, Custom Object Records, Relationship Types, Relationship Records

    Under Construction

    Support

    • [ ] Brands
    • [ ] User Identities
    • [ ] User Passwords
    • [ ] Requests
    • [ ] Ticket Metric Events
    • [ ] Attachments
    • [ ] Sessions
    • [ ] Triggers
    • [ ] Automations
    • [ ] SLA Policies
    • [ ] Targets
    • [ ] Target Failures
    • [ ] Macros
    • [ ] Dynamic Content
    • [ ] Locales
    • [ ] Schedules
    • [ ] Sharing Agreements
    • [ ] Support Addresses
    • [ ] Skill-based Routing
    • [ ] Incremental Skill-based Routing
    • [ ] Workspaces
    • [ ] Apps
    • [ ] App Installation Locations
    • [ ] App Locations
    • [ ] OAuth Clients
    • [ ] OAuth Tokens
    • [ ] OAuth Tokens for Grant Types
    • [ ] Authorized Global Clients
    • [ ] Account Settings
    • [ ] Bookmarks
    • [ ] Push Notification Devices
    • [ ] Resource Collections
    • [ ] Channel Framework
    • [ ] Twitter Channel

    Sunshine

    • [ ] Custom Objects Events
    • [ ] Jobs
    • [ ] Limits
    • [ ] Events
    • [ ] Profiles
    • [ ] People

    APIs Up Next

    • Help Center API
    • Chat API
    • Talk API
    • Sell API
    • Answer Bot API
    • Status API
    • Reseller API
    • NPS API

    Install

    npm i @androozka/zendesk-api-js@2.0.1

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    150 kB

    Total Files

    51

    Last publish

    Collaborators

    • androozka