eligible 2.6.0 → 2.6.1

data/ChangeLog

@@ -1,3 +1,10 @@
+2016-05-10  Eligible  <support@eligible.com>
+	* 2.6.1
+        - Suppressing ssl_verify_callback return code warning
+        - Added new endpoints: received_pdf, precert and referral
+        - Refactored the code and fixed couple of bugs
+        - Documentation updates for the endpoints
+
 2016-02-23  Eligible  <support@eligible.com>
 	
 	* 2.6.0

data/README.md

@@ -36,7 +36,7 @@ Eligible.test = true
 On each api call, you can overwrite the api key or the test parameter:
 
 ```ruby
-Eligible::Demographic.get({:api_key => 'NEW_KEY', :test => false})
+Eligible::Coverage.get({:api_key => 'NEW_KEY', :test => false})
 ```
 
 ### Response Format
@@ -45,7 +45,7 @@ By default, all responses are in JSON, but you can request raw
 access to X12 by adding is as a parameter on the api call:
 
 ```ruby
-Eligible::Demographic.get({:format => "x12"})
+Eligible::Coverage.get({:format => "x12"})
 ```
 
 # Important notes
@@ -56,8 +56,9 @@ the parameter `payer_id`, required for most of the api calls, is
 provided by Eligible from its website, in xml and json format, which
 you can embed into your applications.
 
-[https://eligible.com/resources/information-sources.xml](https://eligible.com/resources/information-sources.xml)  
-[https://eligible.com/resources/information-sources.json](https://eligible.com/resources/information-sources.json)
+[https://eligible.com/resources/payers/eligibility.xml](https://eligible.com/resources/payers/eligibility.xml)
+
+[https://eligible.com/resources/payers/eligibility.json](https://eligible.com/resources/payers/eligibility.json)
 
 ## Payer List for Claims
 
@@ -65,8 +66,23 @@ the parameter `payer_id`, required for claims, is provided by Eligible
 from its website, in xml and json format, which you can embed into
 your applications.
 
-[https://eligible.com/resources/claims-payer.xml](https://eligible.com/resources/claims-payer.xml)  
-[https://eligible.com/resources/claims-payer.json](https://eligible.com/resources/claims-payer.json)
+## Medical
+
+[https://eligible.com/resources/payers/claims/medical.xml](https://eligible.com/resources/payers/claims/medical.xml)
+
+[https://eligible.com/resources/payers/claims/medical.json](https://eligible.com/resources/payers/claims/medical.json)
+
+## Institutional
+
+[https://eligible.com/resources/payers/claims/institutional.xml](https://eligible.com/resources/payers/claims/institutional.xml)
+
+[https://eligible.com/resources/payers/claims/institutional.json](https://eligible.com/resources/payers/claims/institutional.json)
+
+## Dental
+
+[https://eligible.com/resources/payers/claims/dental.xml](https://eligible.com/resources/payers/claims/dental.xml)
+
+[https://eligible.com/resources/payers/claims/dental.json](https://eligible.com/resources/payers/claims/dental.json)
 
 ## Service Type Codes
 
@@ -91,16 +107,16 @@ On all results you can check for errors in `result.error`. The raw
 json format is available by using `result.to_hash`.
 
 ```ruby
-demographic = Eligible::Demographic.get(params)
-demographic.error
-demographic.to_hash
+coverage = Eligible::Coverage.get(params)
+coverage.error
+coverage.to_hash
 ```
 
 ## Coverage
 
 ### Reference
 
-[https://eligible.com/rest#coverage](https://eligible.com/rest#coverage)
+[https://reference.eligible.com/#coverage](https://reference.eligible.com/#coverage)
 
 ### Retrieve eligibility and benefit information
 
@@ -123,34 +139,35 @@ coverage.to_hash # returns all coverage info for the request
 coverage.error   # return error, if any
 ```
 
-## Demographic
+## Cost Estimate
 
 ### Reference
+[https://eligible.com/reference/cost-estimates](https://eligible.com/reference/cost-estimates)
 
-[https://eligible.com/rest#demographics](https://eligible.com/rest#demographics)
-
-### Fetch demographics for a patient
+### Retrieve cost estimate information
 
 ```ruby
 params = {
-  :payer_name => "Aetna",
-  :payer_id   => "000001",
-  :provider_last_name => "Last",
-  :provider_first_name => "First",
-  :provider_npi => "12345678",
-  :member_id => "12345678",
-  :member_last_name => "Austen",
-  :member_first_name => "Jane",
-  :member_dob => "1955-12-14"
+  service_type: '98',
+  network: 'IN',
+  payer_id: '00001',
+  provider_npi: '1234567893',
+  member_id: 'COST_ESTIMATE_001',
+  member_dob: '1886-01-01',
+  provider_price: '200',
+  level: 'individual'
 }
 
-demographic = Eligible::Demographic.get(params)
-demographic.to_hash # returns all coverage info for the request
-demographic.error   # return error, if any
+cost_estimate = Eligible::Coverage.cost_estimate(params)
+cost_estimate.to_hash # returns all coverage info along with cost estimate
 ```
 
 ## Medicare
 
+### Reference
+
+[https://reference.eligible.com/#medicare](https://reference.eligible.com/#medicare)
+
 ### Retrieve eligibility and benefit information from CMS Medicare for a patient.
 
 ```ruby
@@ -173,7 +190,7 @@ medicare.error   # return error, if any
 
 All the batch api calls will notify the results via webhook. You can
 setup a webhook in your
-[Dashboard](https://ligible.com/dashboard/webhooks). All batch api
+[Dashboard](https://eligible.com/dashboard/webhooks). All batch api
 calls return a *reference_id* value and the *number_of_items*
 submitted.
 
@@ -215,42 +232,6 @@ result.to_hash # returns the api call results
 result.error   # return error, if any
 ```
 
-### Demographic Batch API
-
-```ruby
-params = {
-    "parameters"=>[
-        {
-            "id"=>1,
-            "payer_name"=>"UnitedHealthCare",
-            "payer_id"=>"00112",
-            "service_provider_npi"=>"12341234",
-            "subscriber_id"=>"98769876",
-            "subscriber_first_name"=>"Jane",
-            "subscriber_last_name"=>"Austen",
-            "service_provider_last_name"=>"Gaurav",
-            "service_provider_first_name"=>"Gupta",
-            "subscriber_dob"=>"1947-10-07"
-        },
-        {
-            "id"=>2,
-            "payer_name"=>"UnitedHealthCare",
-            "payer_id"=>"00112",
-            "service_provider_npi"=>"67676767",
-            "subscriber_id"=>"98989898",
-            "subscriber_first_name"=>"Gaurav",
-            "subscriber_last_name"=>"Gupta",
-            "service_provider_last_name"=>"Jane",
-            "service_provider_first_name"=>"Austen",
-            "subscriber_dob"=>"1947-08-15"
-        }
-    ]
-}
-result = Eligible::Demographic.batch_post(params)
-result.to_hash # returns the api call results
-result.error   # return error, if any
-```
-
 ### Medicare Batch API
 
 ```ruby
@@ -290,6 +271,9 @@ Enrollment requests can have multiple enrollment NPIs. You can repeat
 the enrollment for a NPI multiple times across different enrollment
 requests.
 
+### Reference
+[https://reference.eligible.com/#enrollment-introduction](https://reference.eligible.com/#enrollment-introduction)
+
 ### Create an Enrollment Request
 
 ```ruby
@@ -343,6 +327,10 @@ enrollment = Eligible::Enrollment.get(params)
 
 ## Claims
 
+### Reference
+
+[https://reference.eligible.com/#create-a-claim](https://reference.eligible.com/#create-a-claim)
+
 ### Create Claim object
 
 ```ruby
@@ -438,7 +426,7 @@ claim = Eligible::Claim.get(params) # returns acknowledgment information on an i
 
 ### Reference
 
-[https://eligible.com/rest#payment-status](https://eligible.com/rest#payment-status)
+[https://reference.eligible.com/#payment-status](https://reference.eligible.com/#payment-status)
 
 ### Retrieve  Payment status
 
@@ -473,6 +461,10 @@ result = Eligible::X12.post(params)
 
 ## Tickets
 
+### Reference
+
+[https://reference.eligible.com/#create-a-ticket](https://reference.eligible.com/#create-a-ticket)
+
 ### Create a ticket
 
 ```ruby
@@ -528,6 +520,226 @@ comments.error   # return error, if any
 Eligible::Ticket.all
 ```
 
+## Customer
+
+### Reference
+
+[https://reference.eligible.com/#customers-introduction](https://reference.eligible.com/#customers-introduction)
+
+### Create a customer
+
+```ruby
+customer_params = { customer: { name: "ABC company", 
+                                site_name: "ABC site name"
+                              }
+                  }
+customer_response = Eligible::Customer.post(customer_params)
+customer_response.to_json
+```
+
+### Get a customer
+
+```ruby
+customer_params = { customer_id: "123" }
+customer_response = Eligible::Customer.get(customer_params)
+customer_response.to_json
+```
+
+### Update a customer
+
+```ruby
+customer_params = { customer_id: "123",
+                    customer: { site_name: "XYZ site name" }
+                  }
+customer_response = Eligible::Customer.update(customer_params)
+customer_response.to_json
+```
+
+### Get all customers
+
+```ruby
+customer_params = {}
+customer_response = Eligible::Customer.all(customer_params)
+customer_response.to_json
+```
+
+## Received Pdf
+
+### Reference
+
+[https://reference.eligible.com/#view-received-pdf](https://reference.eligible.com/#view-received-pdf)
+
+### Get received pdf
+
+```ruby
+params = { enrollment_npi_id: '123' }
+response = Eligible::ReceivedPdf.get(params)
+response.to_hash
+```
+
+### Download received pdf
+By default, it downloads to /tmp/received_pdf.pdf
+```ruby
+params = { enrollment_npi_id: '123', filename: 'file_path_where_to_download' }
+Eligible::ReceivedPdf.download(params)
+```
+
+## Original Signature Pdf
+
+### Reference
+
+[https://reference.eligible.com/#create-original-signature-pdf](https://reference.eligible.com/#create-original-signature-pdf)
+
+### Get original signature pdf
+
+```ruby
+params = { enrollment_npi_id: '123' }
+response = Eligible::OriginalSignaturePdf.get(params)
+response.to_hash
+```
+
+### Create original signature pdf
+
+```ruby
+params = { enrollment_npi_id: '123' }
+params[:file] = File.new('path_to_file')
+response = Eligible::OriginalSignaturePdf.post(params)
+response.to_hash
+```
+
+### Update original signature pdf
+
+```ruby
+params = { enrollment_npi_id: '123' }
+params[:file] = File.new('path_to_new_file')
+response = Eligible::OriginalSignaturePdf.update(params)
+response.to_hash
+```
+
+### Download original signature pdf
+By default, it downloads to /tmp/original_signature_pdf.pdf
+```ruby
+params = { enrollment_npi_id: '123', filename: 'file_path_where_to_download' }
+Eligible::OriginalSignaturePdf.download(params)
+```
+
+### Delete original signature pdf
+
+```ruby
+params = { enrollment_npi_id: '123' }
+response = Eligible::OriginalSignaturePdf.delete(params)
+response.to_hash
+```
+
+## Payer
+
+### Reference
+
+[https://reference.eligible.com/#introduction](https://reference.eligible.com/#introduction)
+
+### List all the payers
+
+```ruby
+response = Eligible::Payer.list({})
+response.collect { |payer| payer.to_hash }
+```
+
+### View a single payer
+
+```ruby
+params = { payer_id: '12345' }
+response = Eligible::Payer.get(params)
+response.to_hash
+```
+
+### Search options for a payer
+
+```ruby
+params = { payer_id: '12345' }
+response = Eligible::Payer.search_options(params)
+response.to_hash
+``` 
+
+### Search options for all payers
+
+```ruby
+response = Eligible::Payer.search_options({})
+response.collect { |payer| payer.to_hash }
+```
+
+## Precertification
+
+### Reference
+
+[https://reference.eligible.com/#precertification](https://reference.eligible.com/#precertification)
+
+### Inquiry
+
+```ruby
+params = { provider_npi: '1234567893',
+           member_id: 'ABCDEF',
+           member_dob: '2016-03-04'
+         }
+response = Eligible::Precert.inquiry(params)
+response.to_hash
+```
+
+### Create
+
+```ruby
+params = { 'requester' => { 'information' => 'test' },
+           'subscriber' => { 'last_name' => 'XYZ',
+                             'first_name' => 'AVC',
+                             'id' => '231213'
+                           },
+           'event' => { 'provider' => 'information' },
+           'services' => [{ 'service' => 'test' }]
+         }
+response = Eligible::Precert.create(params)
+response.to_hash
+```
+
+## Referral
+
+### Inquiry
+
+```ruby
+params = { provider_npi: '1234567893',
+           member_id: 'ABCDEF',
+           member_dob: '2016-03-04'
+         }
+response = Eligible::Referral.inquiry(params)
+response.to_hash
+```
+
+### Create
+
+```ruby
+params = { 'requester' => { 'information' => 'test' },
+           'subscriber' => { 'last_name' => 'XYZ',
+                             'first_name' => 'AVC',
+                             'id' => '231213'
+                           },
+           'event' => { 'provider' => 'information' },
+           'services' => [{ 'service' => 'test' }]
+         }
+response = Eligible::Referral.create(params)
+response.to_hash
+```
+
+## Errors
+
+This is the list of errors thrown from the eligible ruby gem.
+
+1. Eligible::EligibleError - Base class for the customized errors raised from Eligible gem.
+2. Eligible::APIError - Raised when there is some invalid response from the api call. Raised for error codes other than 400, 401 and 404.
+3. Eligible::APIConnectionError - Raised when there is some network issue like socket error, not able to connect to Eligible etc.
+4. Eligible::InvalidRequestError - Raised when error code is 400 or 404.
+5. Eligible::AuthenticationError - Raised when authentication fails. Mostly due to wrong api key.
+6. NotImplementedError - Raised when the functionality you are trying to use doesn't exist.
+7. ArgumentError - Raised when all the required params are not provided.
+
+
 ## Contributing
 
 Running `rake` will run the test suite along with rubocop as a basic