Skip to content

PacerProClient - the Ruby gem for the PacerPro

Notifications You must be signed in to change notification settings

PacerPRO/pacer_pro_client_rb

Repository files navigation

pacer_pro_client

PacerProClient - the Ruby gem for the PacerPro

PacerPro API documentation.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.2.1
  • Package version: 0.2.1
  • Build package: class io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build pacer_pro_client.gemspec

Then either install the gem locally:

gem install ./pacer_pro_client-0.2.1.gem

(for development, run gem install --dev ./pacer_pro_client-0.2.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'pacer_pro_client', '~> 0.2.1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/PacerPro/pacer_pro_client_rb, then add the following in the Gemfile:

gem 'pacer_pro_client', :git => 'https://github.com/PacerPro/pacer_pro_client_rb.git.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'pacer_pro_client'

api_instance = PacerProClient::AuthenticationApi.new


begin
  #Initial authentication.
  session = api_instance.session_create(email: YOUR_EMAIL, password: YOUR_PASSWORD)
  PacerProClient.configure do |config|
    config.api_key['Authorization'] = session.jwt_token
  end
rescue PacerProClient::ApiError => e
  puts "Exception when calling AuthenticationApi->session_create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.pacerpro.com/v1

Class Method HTTP request Description
PacerProClient::AuthenticationApi session_create POST /session Initial authentication.
PacerProClient::AuthenticationApi session_delete DELETE /session Revoke all JWT tokens (logout).
PacerProClient::AuthenticationApi session_refresh GET /session Refresh authentication token
PacerProClient::MattersApi matters_get_collection GET /matters A collection of matters.
PacerProClient::MattersApi matters_get_one GET /matters/{matterId} A single matter.

Documentation for Models

Documentation for Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header