Socket
Book a DemoInstallSign in
Socket

HelpDeskAPI

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

HelpDeskAPI

1.0.0
bundlerRubygems
Version published
Maintainers
1
Created
Source

Ruby library for Spiceworks Help Desk.

Currently only basic actions have been implemented.

Installation

$ gem build helpdeskapi.gemspec
$ gem install ./HelpDeskAPI-1.0.0.gem

Note: Some actions require administrator user

Signing in

HelpDeskAPI::Client.new 'user@example.com', 'password'

Tickets

# All tickets
HelpDeskAPI::Tickets.all

# Open tickets
HelpDeskAPI::Tickets.open

# Closed tickets
HelpDeskAPI::Tickets.closed

# My tickets
HelpDeskAPI::Tickets.my

# Unassigned tickets
HelpDeskAPI::Tickets.unassigned

# Waiting tickets
HelpDeskAPI::Tickets.waiting

# Past due tickets
HelpDeskAPI::Tickets.past_due

# Search for a ticket
HelpDeskAPI::Tickets.search 'Summary'

# Ticket creation
ticket = HelpDeskAPI::Ticket.new 'Summary', 'Description', user.id, HelpDeskAPI::Ticket::Priority::HIGH
ticket.submit

# Delete ticket
ticket.delete

Comments

# Save comment
comment = ticket.comment 'This is a comment'
comment.save
# or
comment = HelpDeskAPI::Comment.new ticket.id, 'This is a comment'
comment.save

# Get all comment for a ticket
ticket.comments
# or
HelpDeskAPI::Comments.comments ticket.id

Users

# Get users (Administrators and Techs)
HelpDeskAPI::Users.users

Organizations

# All organizations
HelpDeskAPI::Organizations.organizations

FAQs

Package last updated on 30 Jul 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.