pokitdok-ruby 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e5fc97ed93ded2d7833c84d29c18d063bb981d7
-  data.tar.gz: 91f2ccc9591cb8d70c291beb809b67be1213c055
+  metadata.gz: b39ac044a97e9ac83136372927fe6c5bfa6870b9
+  data.tar.gz: 21f88737cc7b018516557e852a0e4442592907cc
 SHA512:
-  metadata.gz: b43e6fd5e7fe7769c281944a0a9590abab65851ea1f8cb9cecdec1b704616b5600cbf53e9a647c3c8ff6d1d4602565c759fd0e60ac5c23afc3ffc83a34090139
-  data.tar.gz: 3dea34981e2c905a08e9fe87bf851019e5f145ef804128d79ad61ef9559140e882e2b7d317840e3365211113b3cce98bb05461063c55ac7c0d3389d520cd7b31
+  metadata.gz: 729e896046445e051c1f85592df8d7a53d084f2639cf7cb800ba3350140b242d5814f133a6b8209b4265e8ebad4ac818aeab0a2c3e658ca8d685b12a8625ce1b
+  data.tar.gz: 9ba4038b4f3c01de58be59952063e80b292feb62228c366689dd66e0b1f3c82c84f3935b01b4f16888073865c5c6878d0961c503c9744e160883918dbcc80ffe

data/Dockerfile-1.9

@@ -0,0 +1,2 @@
+FROM ruby:1.9-onbuild
+RUN bundle exec rake spec

data/Dockerfile-2.0

@@ -0,0 +1,2 @@
+FROM ruby:2.0-onbuild
+RUN bundle exec rake spec

data/Dockerfile-2.1

@@ -0,0 +1,2 @@
+FROM ruby:2.1-onbuild
+RUN bundle exec rake spec

data/Dockerfile-2.2

@@ -0,0 +1,2 @@
+FROM ruby:2.2-onbuild
+RUN bundle exec rake spec

data/Dockerfile-2.3

@@ -0,0 +1,2 @@
+FROM ruby:2.3-onbuild
+RUN bundle exec rake spec

data/Dockerfile-J9.1

@@ -0,0 +1,2 @@
+FROM jruby:9.1-onbuild
+RUN bundle exec rake spec

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 gem 'oauth2', '~> 1.0', require: 'oauth2'
 gem 'multipart-post', '~> 2.0'
+gem 'dotenv-rails', groups: [:development, :test]
 
 group :development do
 	gem 'bundler', '~> 1.0'
@@ -12,7 +13,6 @@ group :development do
 	gem 'jeweler', '~> 2.0'
 	gem 'ansi', '~> 1.4'
 	gem 'minitest-reporters', '~> 1.0'
-	gem 'webmock', '~> 1.17'
 	gem 'guard', '~> 2.6'
 	gem 'guard-minitest', '~> 2.2'
 	gem 'terminal-notifier'

data/Gemfile.lock

@@ -1,6 +1,25 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
     addressable (2.4.0)
     ansi (1.5.0)
     ast (2.0.0)
@@ -16,13 +35,16 @@ GEM
       simplecov (~> 0.10.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     docile (1.1.5)
     domain_name (0.5.24)
       unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.2.0)
+    dotenv-rails (2.2.0)
+      dotenv (= 2.2.0)
+      railties (>= 3.2, < 5.1)
+    erubis (2.7.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     ffi (1.9.8)
@@ -57,6 +79,7 @@ GEM
     hitimes (1.2.2-java)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
+    i18n (0.8.0)
     jeweler (2.1.1)
       builder
       bundler (>= 1.0)
@@ -74,6 +97,8 @@ GEM
       celluloid (~> 0.16.0)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
     lumberjack (1.0.9)
     metaclass (0.0.4)
     method_source (0.8.2)
@@ -119,6 +144,21 @@ GEM
       slop (~> 3.4)
       spoon (~> 0.0)
     rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.8)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rainbow (2.0.0)
     rake (11.2.2)
     rb-fsevent (0.9.5)
@@ -137,7 +177,6 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
     ruby-progressbar (1.7.5)
-    safe_yaml (1.0.4)
     semver (1.0.1)
     shellany (0.0.1)
     simplecov (0.10.0)
@@ -158,13 +197,12 @@ GEM
     timers (4.0.1)
       hitimes
     tins (1.5.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
     unf (0.1.4-java)
     unf_ext (0.0.7.1)
-    webmock (1.21.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
 
 PLATFORMS
   java
@@ -174,6 +212,7 @@ DEPENDENCIES
   ansi (~> 1.4)
   bundler (~> 1.0)
   coveralls
+  dotenv-rails
   guard (~> 2.6)
   guard-minitest (~> 2.2)
   guard-rubocop (~> 1.0)
@@ -188,7 +227,6 @@ DEPENDENCIES
   simplecov (~> 0.8)
   terminal-notifier
   terminal-notifier-guard (~> 1.5)
-  webmock (~> 1.17)
 
 BUNDLED WITH
-   1.12.5
+   1.14.3

data/README.md

@@ -1,4 +1,3 @@
-[![Build Status](https://travis-ci.org/pokitdok/pokitdok-ruby.svg?branch=master)](https://travis-ci.org/pokitdok/pokitdok-ruby)
 [![Gem Version](https://badge.fury.io/rb/pokitdok-ruby.svg)](http://badge.fury.io/rb/pokitdok-ruby)
 [![Dependency Freshness](https://www.versioneye.com/user/projects/538e498b46c4739edd0000ee/badge.svg)](https://www.versioneye.com/user/projects/538e498b46c4739edd0000ee)
 
@@ -19,11 +18,44 @@ PokitDok Platform API Client for Ruby
 
 ## Installation
     gem install pokitdok-ruby
+    
+## Client ID and Secret Keys
+Always use environment variables to store your PokitDok client and secret keys. To do so, 
+we recommmend either using `dotenv` or setting plain old Linux OS environment variables.  The dotenv gem is very 
+similar to Figaro, except it loads environment variables from .env, and it doesn't use YAML.
+
+To use `dotenv`, just install the gem by adding to your Gemfile:
+```
+gem 'dotenv-rails', groups: [:development, :test]
+```
+
+And add your configuration values to a `.env` file. Make sure you git ignore the file so that you don't 
+accidentally publish it to github:
+```
+POKITDOK_CLIENT_ID=your_client_id
+POKITDOK_CLIENT_SECRET=your_secret_id
+```
+You can then access the values in your Ruby ENV hash
+```
+require 'dotenv'
+Dotenv.load
+client_id = ENV["POKITDOK_CLIENT_ID"]
+client_secret = ENV["POKITDOK_CLIENT_SECRET"]
+```
+
+It's also possible to maintain unique sets of environment variables per app using basic linux commands. 
+One approach is to have each app running on your server be owned by a different user. You can then use the user's `.bashrc`
+to store application-specific values.
 
 ## Quick Start
 ```ruby
 require 'pokitdok'
-pd = PokitDok::PokitDok.new("your_client_id", "your_client_secret")
+require 'dotenv'
+Dotenv.load
+
+client_id = ENV["POKITDOK_CLIENT_ID"]
+client_secret = ENV["POKITDOK_CLIENT_SECRET"]
+pd = PokitDok::PokitDok.new(client_id, client_secret)
 
 # Retrieve provider information by NPI
 pd.providers(npi: '1467560003')
@@ -126,14 +158,21 @@ pd.request('/ssl/')
 ```
 
 ## Supported Ruby Versions
-This library aims to support and is tested against these Ruby versions, 
-using travis-ci:
-
-* 2.2.3
-* 2.1.1
-* 2.0.0
-* 1.9.3
-* JRuby in 1.9 mode
+This library aims to support and is tested against these Ruby versions using the official [Docker Image packing for Ruby](https://github.com/docker-library/ruby). 
+To use the Dockerfile within this project to run the tests, please head over to the [Docker Install Guide](https://docs.docker.com/engine/installation/)
+
+* 2.3
+* 2.2
+* 2.1
+* 2.0
+* 1.9
+* JRuby 9.1  (which is running Ruby 2.3.1)
+
+To execute the tests against those versions within a Docker Container, build the image and the tests will execute on build:
+```shell
+
+docker build .
+```
 
 You may have luck with other interpreters - let us know how it goes.
 

data/VERSION

@@ -1 +1 @@
-0.8.1
+0.9.0

data/examples/quick_start.rb

@@ -0,0 +1,45 @@
+require 'pokitdok'
+require 'dotenv'
+Dotenv.load
+
+########################
+# make a .env file at the top of your project with
+# POKITDOK_CLIENT_ID=your_client_id
+# POKITDOK_CLIENT_SECRET=your_secret_id
+########################
+
+client_id = ENV["POKITDOK_CLIENT_ID"]
+client_secret = ENV["POKITDOK_CLIENT_SECRET"]
+pd = PokitDok::PokitDok.new(client_id, client_secret)
+
+# Retrieve provider information by NPI
+pd.providers(npi: '1467560003')
+
+# Search providers by name (individuals)
+pd.providers(first_name: 'JEROME', last_name: 'AYA-AY')
+
+# Search providers by name (organizations)
+pd.providers(name: 'Qliance')
+
+# Search providers by location and/or specialty
+pd.providers(zipcode: '29307', radius: '10mi')
+pd.providers(zipcode: '29307', radius: '10mi', specialty: 'RHEUMATOLOGY')
+
+# Eligibility
+@eligibility_query = {
+    member: {
+        birth_date: '1970-01-01',
+        first_name: 'Jane',
+        last_name: 'Doe',
+        id: 'W000000000'
+    },
+    provider: {
+        first_name: 'JEROME',
+        last_name: 'AYA-AY',
+        npi: '1467560003'
+    },
+    service_types: ['health_benefit_plan_coverage'],
+    trading_partner_id: 'MOCKPAYER'
+}
+
+pd.eligibility @eligibility_query

data/lib/OAuthApplicationClient.rb

@@ -77,17 +77,16 @@ class OAuthApplicationClient
       fetch_access_token()
     end
     url = URI.parse(@api_url + endpoint)
-
     File.open(file) do |f|
       additional_params = params.merge({'file' => UploadIO.new(f, 'application/EDI-X12', file)})
       req = Net::HTTP::Post::Multipart.new(url.path, additional_params)
-
       req['Authorization'] = "Bearer #{self.token.token}"
       req['User-Agent'] = @user_agent
 
-      @response = Net::HTTP.start(url.host, url.port) do |http|
+      @response = Net::HTTP.start(url.host, url.port, :use_ssl => true) do |http|
         http.request(req)
       end
+      @status_code = @response.code.to_i
       JSON.parse(@response.body)
     end
   end

data/lib/pokitdok.rb

@@ -20,6 +20,7 @@ module PokitDok
     attr_reader :api_client # :nodoc:
     attr_reader :api_url
     attr_reader :version
+    attr_reader :status_code
 
     # Connect to the PokitDok API with the specified Client ID and Client
     # Secret.
@@ -35,35 +36,109 @@ module PokitDok
                    redirect_uri=nil, scope= nil, code=nil, token= nil)
       @version = version
       @api_url = "#{base}/api/#{version}"
-      @user_agent = "pokitdok-ruby 0.8 #{RUBY_DESCRIPTION}"
-
+      @user_agent = "pokitdok-ruby#0.9.0##{Gem::Platform.local.os}##{Gem::Platform.local.version}"
       super(client_id, client_secret, '/oauth2/token', redirect_uri, scope, code, token, user_agent)
     end
 
-    # Invokes the appointments endpoint, to query for open appointment slots
-    # (using pd_provider_uuid and location) or booked appointments (using
-    # patient_uuid).
+    #
+    # ******************************
+    # General Use APIs
+    # ******************************
+    #
+
+    # Invokes the the general request method for submitting API request.
+    #
+    # +endpoint+ the API request path
+    # +method+ the http request method that should be used
+    # +file+ file when the API accepts file uploads as input
+    # +params+ an optional Hash of parameters
+    #
+    # NOTE: There might be a better way of achieving the seperation of get/get_request
+    # but currently using the "send" method will go down the ancestor chain until the correct
+    # method is found. In this case the 'httpMethod'_request
+    def request(endpoint, method='get', file=nil, params={})
+      method = method.downcase
+      if file
+        self.send("post_file", endpoint, file)
+      else
+        if endpoint[0] == '/'
+          endpoint[0] = ''
+        end
+        # Work around to delete the leading slash on the request endpoint
+        # Currently the module we're using appends a slash to the base url
+        # so an additional url will break the request.
+        # Refer to ...faraday/connection.rb L#404
+        self.send("#{method}_request", endpoint, params)
+      end
+    end
+
+    public
+    def get(endpoint, params = {})
+      response = request(endpoint, 'GET', nil, params)
+      @status_code = response.status
+      JSON.parse(response.body)
+    end
+
+    def post(endpoint, params = {})
+      response = request(endpoint, 'POST', nil, params)
+      @status_code = response.status
+      JSON.parse(response.body)
+    end
+
+    def put(endpoint, params = {})
+      response = request(endpoint, 'PUT', nil, params)
+      @status_code = response.status
+      JSON.parse(response.body)
+    end
+
+    def delete(endpoint, params = {})
+      response = request(endpoint, 'DELETE', nil, params)
+      @status_code = response.status
+      if response.body.empty?
+        response.status == 204
+      else
+        JSON.parse(response.body)
+      end
+    end
+
+    # Invokes the activities endpoint.
+    #
+    # This endpoint uses the user_schedule OAuth2 scope. You'll need to
+    # get the user's authorization via our OAuth2 provider
     #
     # +params+ an optional Hash of parameters
     #
-    def activities(params = {})
-      get('activities/', params)
+    def activities(activity_id = nil, params = {})
+      activities_endpoint = 'activities/'
+      if activity_id
+        activities_endpoint = "activities/#{activity_id}" + activity_id.to_s
+      end
+      get(activities_endpoint, params)
     end
 
-    # Invokes the authorizations endpoint.
+    # Invokes the trading partners endpoint.
     #
-    # +params+ an optional hash of parameters that will be sent in the POST body
+    # +params+ an optional Hash of parameters
     #
-    def authorizations(params = {})
-      post('authorizations/', params)
+    def trading_partners(trading_partner_id = nil, params = {})
+      if params
+        trading_partner_id = params.delete :trading_partner_id
+      end
+      get("tradingpartners/#{trading_partner_id}")
     end
 
-    # Invokes the cash prices endpoint.
+    #
+    # ******************************
+    # X12 API Convenience Functions
+    # ******************************
+    #
+
+    # Invokes the authorizations endpoint: Submit an authorization request
     #
     # +params+ an optional hash of parameters that will be sent in the POST body
     #
-    def cash_prices(params = {})
-      get('prices/cash', params)
+    def authorizations(params = {})
+      post('authorizations/', params)
     end
 
     # Invokes the claims endpoint.
@@ -82,24 +157,8 @@ module PokitDok
       post('claims/status', params)
     end
 
-    # Invokes the ICD convert endpoint.
-    #
-    # +params+ an optional hash of parameters
-    #
-    def icd_convert(params = {})
-      get("icd/convert/#{params[:code]}")
-    end
-
-    # Invokes the mpc endpoint.
-    #
-    # +params+ an optional hash of parameters
-    #
-    def mpc(params = {})
-      get('mpc/', params)
-    end
-
     # Uploads an .837 file to the claims convert endpoint.
-    # Uses the multipart-post gem, since oauth2 doesn't support multipart.
+    # Uses the multipart-post gem, since oauth2 adoesn't support multipart.
     #
     # +x12_claims_file+ the path to the file to transmit
     #
@@ -120,6 +179,7 @@ module PokitDok
     # +params+ an optional hash of parameters that will be sent in the POST body
     #
     def enrollment(params = {})
+      warn "[DEPRECATION] ` enrollment will be removed in the next release"
       post('enrollment/', params)
     end
 
@@ -130,6 +190,7 @@ module PokitDok
     # +x12_file+ the path to the file to transmit
     #
     def enrollment_snapshot(trading_partner_id, x12_file)
+      warn "[DEPRECATION] ` enrollment_snapshot will be removed in the next release"
       request("/enrollment/snapshot/#{trading_partner_id}", "POST", x12_file)
     end
 
@@ -138,6 +199,7 @@ module PokitDok
     # +params+ an optional Hash of parameters
     #
     def enrollment_snapshots(params = {})
+      warn "[DEPRECATION] ` enrollment_snapshots will be removed in the next release"
       snapshot_id = params.delete :snapshot_id
       get("enrollment/snapshot" + (snapshot_id ? "/#{snapshot_id}" : ''), params)
     end
@@ -147,9 +209,48 @@ module PokitDok
     # +params+ an optional Hash of parameters
     #
     def enrollment_snapshot_data(params = {})
+      warn "[DEPRECATION] ` enrollment_snapshot_data will be removed in the next release"
       get("enrollment/snapshot/#{params[:snapshot_id]}/data")
     end
 
+    # Invokes the referrals endpoint.
+    #
+    # +params+ an optional Hash of parameters
+    #
+    def referrals(params = {})
+      post('referrals/', params)
+    end
+
+
+    #
+    # ******************************
+    # DATA API Convenience Functions
+    # ******************************
+    #
+
+    # Invokes the cash prices endpoint.
+    #
+    # +params+ an optional hash of parameters that will be sent in the POST body
+    #
+    def cash_prices(params = {})
+      get('prices/cash', params)
+    end
+
+    # Invokes the ICD convert endpoint.
+    #
+    # +params+ an optional hash of parameters
+    #
+    def icd_convert(params = {})
+      get("icd/convert/#{params[:code]}")
+    end
+
+    # Invokes the mpc endpoint.
+    #
+    # +params+ an optional hash of parameters
+    #
+    def mpc(params = {})
+      get('mpc/', params)
+    end
     # Invokes the insurance prices endpoint.
     #
     # +params+ an optional hash of parameters
@@ -158,11 +259,30 @@ module PokitDok
       get('prices/insurance', params)
     end
 
+    # Invokes the insurance price estimate endpoint
+    # Returns estimated out of pocket cost and eligibility information for a given procedure
+    #
+    # +params+ an optional hash of parameters
+    #
+    def oop_insurance_estimate(params = {})
+      post("/oop/insurance-estimate", params)
+    end
+
+    # Invokes the insurance load price endpoint
+    # Loads procedure prices for a specific trading partner
+    #
+    # +params+ an optional hash of parameters
+    #
+    def oop_insurance_prices(params = {})
+      post("/oop/insurance-load-price", params)
+    end
+
     # Invokes the payers endpoint.
     #
     # +params+ an optional hash of parameters
     #
     def payers(params = {})
+      warn "[DEPRECATION] `payers` will be deprecated in the next release.  Please use `trading_partners` instead."
       get('payers/', params)
     end
 
@@ -182,25 +302,43 @@ module PokitDok
       get('providers/', params)
     end
 
-    # Invokes the referrals endpoint.
+    #
+    # ******************************
+    # Pharmacy API Convenience Functions
+    # ******************************
+    #
+
+    # Invokes the pharmacy plans endpoint.
     #
     # +params+ an optional Hash of parameters
     #
-    def referrals(params = {})
-      post('referrals/', params)
+    def pharmacy_plans(params = {})
+      get('pharmacy/plans', params)
     end
 
-    # Invokes the trading partners endpoint.
+    # Invokes the pharmacy formulary endpoint.
     #
     # +params+ an optional Hash of parameters
     #
-    def trading_partners(params = {})
-      trading_partner_id = params.delete :trading_partner_id
-      get("tradingpartners/#{trading_partner_id}")
+    def pharmacy_formulary(params = {})
+      get('pharmacy/formulary', params)
     end
 
-    # Scheduling endpoints
+    # Invokes the pharmacy network cost endpoint.
+    #
+    # +params+ an optional Hash of parameters
+    #
+    def pharmacy_network(params = {})
+      npi = params.delete :npi
+      endpoint = npi ? "pharmacy/network/#{npi}" : "pharmacy/network"
+      get(endpoint, params)
+    end
 
+    #
+    # ******************************
+    # Scheduling API Convenience Functions
+    # ******************************
+    #
     # Invokes the appointments endpoint to query for an open appointment
     # slot or a booked appointment given a specific pd_appointment_uuid,
     # the PokitDok unique appointment identifier.
@@ -208,19 +346,34 @@ module PokitDok
     # +params+ an optional Hash of parameters
     #
     def appointment(params = {})
+      warn "[DEPRECATION] `appointment` will be deprecated in the next release.  Please use `appointment_types` instead."
       appointment_id = params.delete :appointment_id
       get("schedule/appointmenttypes/#{appointment_id}", params)
     end
 
-    # Invokes the activities endpoint.
+    # Invokes the appointments endpoint, to query for open appointment slots
+    # (using pd_provider_uuid and location) or booked appointments (using
+    # patient_uuid).
     #
-    # This endpoint uses the user_schedule OAuth2 scope. You'll need to
-    # get the user's authorization via our OAuth2 provider
+    # +params+ an optional Hash of parameters
+    #
+    def get_appointments(appointment_uuid=nil, params = {})
+      endpoint = "schedule/appointments/"
+      if appointment_uuid
+        endpoint = "schedule/appointments/#{appointment_uuid}"
+      end
+      get(endpoint, params)
+    end
+
+    # Invokes the appointments endpoint, to query for open appointment slots
+    # (using pd_provider_uuid and location) or booked appointments (using
+    # patient_uuid).
     #
     # +params+ an optional Hash of parameters
     #
-    def appointments(params = {})
-      get('schedule/appointments/', params)
+    def appointments(appointment_uuid=nil, params = {})
+      warn "[DEPRECATION] `appointments` will be deprecated in the next release.  Please use `get_appointments` instead."
+      get_appointments(params, appointment_uuid)
     end
 
     # Invokes the appointment_types endpoint, to get information on a specific
@@ -229,16 +382,22 @@ module PokitDok
     # +params+ an optional Hash of parameters
     #
     def appointment_type(params = {})
+      warn "[DEPRECATION] `appointment_type` will be deprecated in the next release.  Please use `appointment_types` instead."
       appointment_type = params.delete :uuid
       get("schedule/appointmenttypes/#{appointment_type}")
     end
 
     # Invokes the appointment_types endpoint.
+    # Get information about appointment types or fetch data about a specific appointment type
     #
     # +params+ an optional hash of parameters
     #
-    def appointment_types(params = {})
-      get('schedule/appointmenttypes/', params)
+    def appointment_types(appointment_type_uuid=nil, params = {})
+      endpoint = "schedule/appointmenttypes/"
+      if appointment_type_uuid
+        endpoint = "schedule/appointmenttypes/#{appointment_type_uuid}"
+      end
+      get(endpoint, params)
     end
 
     # Books an appointment.
@@ -256,7 +415,7 @@ module PokitDok
     #
     # This endpoint uses the user_schedule OAuth2 scope. You'll need to
     # get the user's authorization via our OAuth2 provider
-    #    
+    #
     # +params+ an optional Hash of parameters
     #
     def cancel_appointment(appointment_uuid, params={})
@@ -264,13 +423,15 @@ module PokitDok
     end
 
     # Invokes the schedule/appointments endpoint.
+    # Query for open appointment slots or retrieve information for a specific appointment
     #
     # This endpoint uses the user_schedule OAuth2 scope. You'll need to
     # get the user's authorization via our OAuth2 provider
-    #    
+    #
     # +params+ an optional hash of parameters
     #
     def open_appointment_slots(params = {})
+      warn "[DEPRECATION] `open_appointment_slots` will be deprecated in the next release.  Please use `get_appointments` instead."
       get('schedule/appointments', params)
     end
 
@@ -278,8 +439,12 @@ module PokitDok
     #
     # +params an optional Hash of parameters
     #
-    def schedulers(params = {})
-      get('schedule/schedulers/', params)
+    def schedulers(scheduler_uuid = nil, params = {})
+      endpoint = "schedule/schedulers/"
+      if scheduler_uuid
+        endpoint = "schedule/schedulers/#{scheduler_uuid}"
+      end
+      get(endpoint, params)
     end
 
     # Invokes the schedulers endpoint, to get information about a specific
@@ -288,6 +453,7 @@ module PokitDok
     # +params+ an optional Hash of parameters
     #
     def scheduler(params = {})
+      warn "[DEPRECATION] `scheduler` will be deprecated in the next release.  Please use `schedulers` instead."
       scheduler_id = params.delete :uuid
       get("schedule/schedulers/#{scheduler_id}")
     end
@@ -296,48 +462,48 @@ module PokitDok
     #
     # This endpoint uses the user_schedule OAuth2 scope. You'll need to
     # get the user's authorization via our OAuth2 provider
-    #    
+    #
     # +params+ an optional Hash of parameters
     #
     def schedule_slots(params = {})
       post('/schedule/slots/', params)
     end
 
-    # Invokes the pharmacy plans endpoint.
+    # Updates the specified appointment.
+    #
+    # This endpoint uses the user_schedule OAuth2 scope. You'll need to
+    # get the user's authorization via our OAuth2 provider
     #
     # +params+ an optional Hash of parameters
     #
-    def pharmacy_plans(params = {})
-      get('pharmacy/plans', params)
+    def update_appointment(appointment_uuid, params={})
+      put("schedule/appointments/#{appointment_uuid}", params)
     end
 
-    # Invokes the pharmacy formulary endpoint.
     #
-    # +params+ an optional Hash of parameters
+    # ******************************
+    # Identity API Convenience Functions
+    # ******************************
     #
-    def pharmacy_formulary(params = {})
-      get('pharmacy/formulary', params)
-    end
 
-    # Invokes the pharmacy network cost endpoint.
+    # Invokes the identity proof question endpoint
+    # Submit a user’s response to a knowledge based authentication question
     #
-    # +params+ an optional Hash of parameters
+    # +params+ a hash of parameters that will be sent in the POST body
     #
-    def pharmacy_network(params = {})
-      npi = params.delete :npi
-      endpoint = npi ? "pharmacy/network/#{npi}" : "pharmacy/network"
-      get(endpoint, params)
+    def answer_proof_question(params = {})
+      post("/identity/proof/questions/score/", params)
     end
 
-    # Updates the specified appointment.
+
+    # Invokes the identity proof questionnaire endpoint
+    # Validates an identity proof request and generates a
+    # Knowledge Based Authentication questionnaire if possible
     #
-    # This endpoint uses the user_schedule OAuth2 scope. You'll need to
-    # get the user's authorization via our OAuth2 provider
-    #    
-    # +params+ an optional Hash of parameters
+    # +params+ a hash of parameters that will be sent in the POST body
     #
-    def update_appointment(appointment_uuid, params={})
-      put("schedule/appointments/#{appointment_uuid}", params)
+    def create_proof_questionnaire(params = {})
+      post("/identity/proof/questions/generate/", params)
     end
 
     # Invokes the identity endpoint for creation
@@ -345,7 +511,7 @@ module PokitDok
     # +params+ a hash of parameters that will be sent in the POST body
     #
     def create_identity(params = {})
-      post('identity/', params)
+      post("identity/", params)
     end
 
     # Invokes the identity endpoint for updating
@@ -361,9 +527,21 @@ module PokitDok
     #
     # +params+ an optional hash of parameters that will be sent in the GET body
     #
-    def identity(params = {})
-      identity_uuid = params.delete :identity_uuid
-      get("identity" + (identity_uuid ? "/#{identity_uuid}" : ''), params)
+    def get_identity(identity_uuid=nil, params = {})
+      endpoint = "/identity"
+      if identity_uuid
+        endpoint = "/identity#{identity_uuid}"
+      end
+      get(endpoint, params)
+    end
+
+    # Invokes the identity endpoint for querying
+    #
+    # +params+ an optional hash of parameters that will be sent in the GET body
+    #
+    def identity(identity_uuid=nil, params = {})
+      warn "[DEPRECATION] `identity` will be deprecated in the next release.  Please use `get_identity` instead."
+      get_identity(params, identity_uuid)
     end
 
     # Invokes the identity history endpoint
@@ -383,59 +561,14 @@ module PokitDok
       post("identity/match", params)
     end
 
-    # Invokes the the general request method for submitting API request.
+    # Invokes the validate identity endpoint
+    #  Tests the validity of an identity through the Identity Proof api
+    # (our knowledge based authentication solution)
     #
-    # +endpoint+ the API request path
-    # +method+ the http request method that should be used
-    # +file+ file when the API accepts file uploads as input
-    # +params+ an optional Hash of parameters
     #
-    # NOTE: There might be a better way of achieving the seperation of get/get_request
-    # but currently using the "send" method will go down the ancestor chain until the correct
-    # method is found. In this case the 'httpMethod'_request
-    def request(endpoint, method='get', file=nil, params={})
-      method = method.downcase
-      if file
-        self.send('post_file', endpoint, file, params)
-      else
-        # Work around to delete the leading slash on the request endpoint
-        # Currently the module we're using appends a slash to the base url
-        # so an additional url will break the request.
-        # Refer to ...faraday/connection.rb L#404
-        if endpoint[0] == '/'
-          endpoint[0] = ''
-        end
-        self.send("#{method}_request", endpoint, params)
-      end
+    def validate_identity(params = {})
+      post("/identity/proof/valid/", params)
     end
 
-    private
-      def get(endpoint, params = {})
-        response = request(endpoint, 'GET', nil, params)
-
-        JSON.parse(response.body)
-      end
-
-      def post(endpoint, params = {})
-        response = request(endpoint, 'POST', nil, params)
-
-        JSON.parse(response.body)
-      end
-
-      def put(endpoint, params = {})
-        response = request(endpoint, 'PUT', nil, params)
-
-        JSON.parse(response.body)
-      end
-
-      def delete(endpoint, params = {})
-        response = request(endpoint, 'DELETE', nil, params)
-
-        if response.body.empty?
-          response.status == 204
-        else
-          JSON.parse(response.body)
-        end
-      end
   end
 end