Code Monkey home page Code Monkey logo

parature's Introduction

Parature

Use this gem to interact with Parature.

Installation

Add this line to your application's Gemfile:

gem 'parature'

And then execute:

$ bundle

Or install it yourself as:

$ gem install parature

Usage

Setup

If you want to use the API functionality, you must provide a Parature API token.

If you want to use the automated functionality through the site, you should create a service account with appropriate access.

Where data is available through the API, that is the preferred source.

Examples

Here's an example of API interaction

% pry
require 'parature'
include Parature

# We need the API token when we retrieve data via the API
Parature.config host: "supportcenteronline.com", account_id: 100, department_id: 4000, token: "apitoken"
tickets = Tickets.all

# Get the next page of tickets
tickets.next_page

# Get the first page of tickets from last week
Tickets.last_week

# Get the first page of tickets from last month
Tickets.last_month

# Get the second page of tickets from this week
Tickets.this_week.next_page 

# Get all the statuses
puts tickets.collect &:status

# Get a single ticket
ticket = Ticket.find '99999'

# Get history information
ticket.history

# Get only history with time spent
ticket.history_with_time

# Get only history with csrs associated
ticket.history_with_csr

# Do the same for all tickets
tickets.history
tickets.history_with_time
tickets.history_with_csr

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

parature's People

Contributors

jamiely avatar

Stargazers

 avatar

Watchers

 avatar  avatar

parature's Issues

Support multiple departments

Some users have access to multiple departments. Make sure that when using the mechanize downloader, the correct department is selected for reports.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.