psi_eligibility 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a675b5054b540e4625d4bb49884fedd77cf293208e9773188a49cf32af4168d7
+  data.tar.gz: 581cff723983e1b838570865ab0d4c04c0a7e1d690629111e00894a182ece27d
+SHA512:
+  metadata.gz: 5fee1e5ce567754fa5aded12eecd2adb4c5a9603c1eb27ecf487ee405e89443261bc64336d1cd617f02b66306ba8e5ade64967a60d89ff2067274b14c9f06383
+  data.tar.gz: ae86ada15d85b37572c701fbea9f3d6a2df1bed2de07847633f1cde24e4c2dda08f5411396a991fda4629174a9773dec5a47ace5247824168c9a14b21fa16d2c

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,123 @@
+# psi_eligibility
+
+PsiEligibility - the Ruby gem for the PSI Candidate Rest Eligibility Service
+
+PSIs REST based service to modify candidate test eligibilities.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build psi_eligibility.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./psi_eligibility-1.0.0.gem
+```
+(for development, run `gem install --dev ./psi_eligibility-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'psi_eligibility', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
+
+    gem 'psi_eligibility', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'psi_eligibility'
+
+# Setup authorization
+PsiEligibility.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PsiEligibility::DefaultApi.new
+
+account_code = 'account_code_example' # String | provided client specific account code.
+
+candidate_id = 'candidate_id_example' # String | The unique candidate id to act on.
+
+test_code = 'test_code_example' # String | The test code.
+
+
+begin
+  #Cancel a candidate's eligibility record.
+  api_instance.cancel_candidate_eligibility(account_code, candidate_id, test_code)
+rescue PsiEligibility::ApiError => e
+  puts "Exception when calling DefaultApi->cancel_candidate_eligibility: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://apiuatapi.psiexams.com/eligibility_service/1.0.0*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PsiEligibility::DefaultApi* | [**cancel_candidate_eligibility**](docs/DefaultApi.md#cancel_candidate_eligibility) | **DELETE** /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code} | Cancel a candidate's eligibility record.
+*PsiEligibility::DefaultApi* | [**create_candidate**](docs/DefaultApi.md#create_candidate) | **POST** /accounts/{account_code}/candidates | Create a new candidate eligibility record.
+*PsiEligibility::DefaultApi* | [**get_candidate**](docs/DefaultApi.md#get_candidate) | **GET** /accounts/{account_code}/candidates/{candidate_id} | Get the eligiblities associated with the candidate id.
+*PsiEligibility::DefaultApi* | [**get_candidate_eligibilities**](docs/DefaultApi.md#get_candidate_eligibilities) | **GET** /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code} | Get the eligiblities associated with the candidate id.
+*PsiEligibility::DefaultApi* | [**get_test_launch_info**](docs/DefaultApi.md#get_test_launch_info) | **GET** /eligibilities/{psi_eligibility_code}/testLaunchInfo | GET test launch url
+*PsiEligibility::DefaultApi* | [**modify_vouchers_of_eligibility**](docs/DefaultApi.md#modify_vouchers_of_eligibility) | **PUT** /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}/vouchers | Associate a set of voucher codes to PSI Candidate Test Eligibility record. Previously attached vouchers to the eligibility record but not listed in the input would be unlinked from the eligibility record. Voucher Codes are agreed upon codes between PSI and the customer (identified by account_code)
+*PsiEligibility::DefaultApi* | [**update_candidate_eligibility**](docs/DefaultApi.md#update_candidate_eligibility) | **PUT** /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code} | Update an existing candidate's eligibility record.
+
+
+## Documentation for Models
+
+ - [PsiEligibility::AdditionalAttributeModel](docs/AdditionalAttributeModel.md)
+ - [PsiEligibility::CandidateModel](docs/CandidateModel.md)
+ - [PsiEligibility::EligibilityModel](docs/EligibilityModel.md)
+ - [PsiEligibility::EligibilityResponseModel](docs/EligibilityResponseModel.md)
+ - [PsiEligibility::ErrorModel](docs/ErrorModel.md)
+ - [PsiEligibility::ExistingEligibilityModel](docs/ExistingEligibilityModel.md)
+ - [PsiEligibility::TestLaunchInfoModel](docs/TestLaunchInfoModel.md)
+
+
+## Documentation for Authorization
+
+
+### default
+
+- **Type**: OAuth
+- **Flow**: implicit
+- **Authorization URL**: https://apiuatapi.psiexams.com/authorize
+- **Scopes**: N/A
+
+### oauth
+
+- **Type**: OAuth
+- **Flow**: password
+- **Authorization URL**: 
+- **Scopes**: N/A
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AdditionalAttributeModel.md

@@ -0,0 +1,9 @@
+# PsiEligibility::AdditionalAttributeModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The vlaue of the additional attribute. | [optional] 
+**key** | **String** | The key agreed upon by PSI and the client in advanced to store a custom candidate attribute. | [optional] 
+
+

data/docs/CandidateModel.md

@@ -0,0 +1,24 @@
+# PsiEligibility::CandidateModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country** | **String** |  | [optional] 
+**home_phone** | **String** |  | [optional] 
+**school_code** | **String** | If supplied, the list of school codes must be added to PSI's system in advance of the import. | [optional] 
+**address2** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**address1** | **String** |  | [optional] 
+**province_state** | **String** | The canidates province, state or equivilent. | [optional] 
+**last_name** | **String** |  | 
+**suffix** | **String** |  | [optional] 
+**middle_name** | **String** |  | [optional] 
+**special_accommodations** | **Array<String>** |  | [optional] 
+**candidate_id** | **String** | The supplied candidates unique id. | 
+**office_phone** | **String** |  | [optional] 
+**postal_code** | **String** | Candidates zip code, postal code or equivilent. | [optional] 
+**first_name** | **String** |  | 
+**email** | **String** |  | [optional] 
+**additional_attributes** | [**Array<AdditionalAttributeModel>**](AdditionalAttributeModel.md) |  | [optional] 
+
+

data/docs/DefaultApi.md

@@ -0,0 +1,411 @@
+# PsiEligibility::DefaultApi
+
+All URIs are relative to *https://apiuatapi.psiexams.com/eligibility_service/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_candidate_eligibility**](DefaultApi.md#cancel_candidate_eligibility) | **DELETE** /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code} | Cancel a candidate's eligibility record.
+[**create_candidate**](DefaultApi.md#create_candidate) | **POST** /accounts/{account_code}/candidates | Create a new candidate eligibility record.
+[**get_candidate**](DefaultApi.md#get_candidate) | **GET** /accounts/{account_code}/candidates/{candidate_id} | Get the eligiblities associated with the candidate id.
+[**get_candidate_eligibilities**](DefaultApi.md#get_candidate_eligibilities) | **GET** /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code} | Get the eligiblities associated with the candidate id.
+[**get_test_launch_info**](DefaultApi.md#get_test_launch_info) | **GET** /eligibilities/{psi_eligibility_code}/testLaunchInfo | GET test launch url
+[**modify_vouchers_of_eligibility**](DefaultApi.md#modify_vouchers_of_eligibility) | **PUT** /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}/vouchers | Associate a set of voucher codes to PSI Candidate Test Eligibility record. Previously attached vouchers to the eligibility record but not listed in the input would be unlinked from the eligibility record. Voucher Codes are agreed upon codes between PSI and the customer (identified by account_code)
+[**update_candidate_eligibility**](DefaultApi.md#update_candidate_eligibility) | **PUT** /accounts/{account_code}/candidates/{candidate_id}/tests/{test_code} | Update an existing candidate's eligibility record.
+
+
+# **cancel_candidate_eligibility**
+> cancel_candidate_eligibility(account_code, candidate_id, test_code)
+
+Cancel a candidate's eligibility record.
+
+Cancels the eligibility matching the supplied candidate eligiblity code.
+
+### Example
+```ruby
+# load the gem
+require 'psi_eligibility'
+# setup authorization
+PsiEligibility.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PsiEligibility::DefaultApi.new
+
+account_code = 'account_code_example' # String | provided client specific account code.
+
+candidate_id = 'candidate_id_example' # String | The unique candidate id to act on.
+
+test_code = 'test_code_example' # String | The test code.
+
+
+begin
+  #Cancel a candidate's eligibility record.
+  api_instance.cancel_candidate_eligibility(account_code, candidate_id, test_code)
+rescue PsiEligibility::ApiError => e
+  puts "Exception when calling DefaultApi->cancel_candidate_eligibility: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_code** | **String**| provided client specific account code. | 
+ **candidate_id** | **String**| The unique candidate id to act on. | 
+ **test_code** | **String**| The test code. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json; charset=UTF-8
+
+
+
+# **create_candidate**
+> EligibilityResponseModel create_candidate(account_code, payload)
+
+Create a new candidate eligibility record.
+
+Submits a single eligibilites to the PSI Atlas system. Many parameters are optional but the more the better.
+
+### Example
+```ruby
+# load the gem
+require 'psi_eligibility'
+# setup authorization
+PsiEligibility.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PsiEligibility::DefaultApi.new
+
+account_code = 'account_code_example' # String | provided client specific account code.
+
+payload = PsiEligibility::EligibilityModel.new # EligibilityModel | A new eligibility record.
+
+
+begin
+  #Create a new candidate eligibility record.
+  result = api_instance.create_candidate(account_code, payload)
+  p result
+rescue PsiEligibility::ApiError => e
+  puts "Exception when calling DefaultApi->create_candidate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_code** | **String**| provided client specific account code. | 
+ **payload** | [**EligibilityModel**](EligibilityModel.md)| A new eligibility record. | 
+
+### Return type
+
+[**EligibilityResponseModel**](EligibilityResponseModel.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json; charset=UTF-8
+
+
+
+# **get_candidate**
+> Array<ExistingEligibilityModel> get_candidate(account_code, candidate_id)
+
+Get the eligiblities associated with the candidate id.
+
+Get's all of the eligibilities associated with the supplied candidate_id. This is useful to decide which specific eligibility needs to be updated or deleted.
+
+### Example
+```ruby
+# load the gem
+require 'psi_eligibility'
+# setup authorization
+PsiEligibility.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PsiEligibility::DefaultApi.new
+
+account_code = 'account_code_example' # String | provided client specific account code.
+
+candidate_id = 'candidate_id_example' # String | the candidate id.
+
+
+begin
+  #Get the eligiblities associated with the candidate id.
+  result = api_instance.get_candidate(account_code, candidate_id)
+  p result
+rescue PsiEligibility::ApiError => e
+  puts "Exception when calling DefaultApi->get_candidate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_code** | **String**| provided client specific account code. | 
+ **candidate_id** | **String**| the candidate id. | 
+
+### Return type
+
+[**Array<ExistingEligibilityModel>**](ExistingEligibilityModel.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json; charset=UTF-8
+
+
+
+# **get_candidate_eligibilities**
+> Array<ExistingEligibilityModel> get_candidate_eligibilities(account_code, candidate_id, test_code)
+
+Get the eligiblities associated with the candidate id.
+
+Get's all of the eligibilities associated with the supplied candidate_id fpr a specific test code.
+
+### Example
+```ruby
+# load the gem
+require 'psi_eligibility'
+# setup authorization
+PsiEligibility.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PsiEligibility::DefaultApi.new
+
+account_code = 'account_code_example' # String | provided client specific account code.
+
+candidate_id = 'candidate_id_example' # String | the candidate id.
+
+test_code = 'test_code_example' # String | The test code.
+
+
+begin
+  #Get the eligiblities associated with the candidate id.
+  result = api_instance.get_candidate_eligibilities(account_code, candidate_id, test_code)
+  p result
+rescue PsiEligibility::ApiError => e
+  puts "Exception when calling DefaultApi->get_candidate_eligibilities: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_code** | **String**| provided client specific account code. | 
+ **candidate_id** | **String**| the candidate id. | 
+ **test_code** | **String**| The test code. | 
+
+### Return type
+
+[**Array<ExistingEligibilityModel>**](ExistingEligibilityModel.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json; charset=UTF-8
+
+
+
+# **get_test_launch_info**
+> TestLaunchInfoModel get_test_launch_info(psi_eligibility_code)
+
+GET test launch url
+
+API endpoint to retrieve the test launch URL for a given eligibility code.
+
+### Example
+```ruby
+# load the gem
+require 'psi_eligibility'
+# setup authorization
+PsiEligibility.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PsiEligibility::DefaultApi.new
+
+psi_eligibility_code = 'psi_eligibility_code_example' # String | 
+
+
+begin
+  #GET test launch url
+  result = api_instance.get_test_launch_info(psi_eligibility_code)
+  p result
+rescue PsiEligibility::ApiError => e
+  puts "Exception when calling DefaultApi->get_test_launch_info: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **psi_eligibility_code** | **String**|  | 
+
+### Return type
+
+[**TestLaunchInfoModel**](TestLaunchInfoModel.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **modify_vouchers_of_eligibility**
+> modify_vouchers_of_eligibility(account_code, candidate_id, test_code, opts)
+
+Associate a set of voucher codes to PSI Candidate Test Eligibility record. Previously attached vouchers to the eligibility record but not listed in the input would be unlinked from the eligibility record. Voucher Codes are agreed upon codes between PSI and the customer (identified by account_code)
+
+### Example
+```ruby
+# load the gem
+require 'psi_eligibility'
+# setup authorization
+PsiEligibility.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PsiEligibility::DefaultApi.new
+
+account_code = 'account_code_example' # String | Account code or the customer code
+
+candidate_id = 'candidate_id_example' # String | Candidate Id
+
+test_code = 'test_code_example' # String | Test Code
+
+opts = { 
+  payload: [PsiEligibility::Array<String>.new] # Array<String> | Voucher Codes to be applied to the candidate's specified exam record
+}
+
+begin
+  #Associate a set of voucher codes to PSI Candidate Test Eligibility record. Previously attached vouchers to the eligibility record but not listed in the input would be unlinked from the eligibility record. Voucher Codes are agreed upon codes between PSI and the customer (identified by account_code)
+  api_instance.modify_vouchers_of_eligibility(account_code, candidate_id, test_code, opts)
+rescue PsiEligibility::ApiError => e
+  puts "Exception when calling DefaultApi->modify_vouchers_of_eligibility: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_code** | **String**| Account code or the customer code | 
+ **candidate_id** | **String**| Candidate Id | 
+ **test_code** | **String**| Test Code | 
+ **payload** | **Array&lt;String&gt;**| Voucher Codes to be applied to the candidate&#39;s specified exam record | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_candidate_eligibility**
+> update_candidate_eligibility(account_code, candidate_id, test_code, payload)
+
+Update an existing candidate's eligibility record.
+
+Update an existing candidate's eligibility details. Information such as candidate demographic data and eligibility, expiration and scheduled start date may be changed. You cannot change the associated test via this call. To do so you must cancel and create a new eligibility.
+
+### Example
+```ruby
+# load the gem
+require 'psi_eligibility'
+# setup authorization
+PsiEligibility.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PsiEligibility::DefaultApi.new
+
+account_code = 'account_code_example' # String | provided client specific account code.
+
+candidate_id = 'candidate_id_example' # String | The unique candidate id to update.
+
+test_code = 'test_code_example' # String | The test code.
+
+payload = PsiEligibility::EligibilityModel.new # EligibilityModel | The candidate's updated eligibity record.
+
+
+begin
+  #Update an existing candidate's eligibility record.
+  api_instance.update_candidate_eligibility(account_code, candidate_id, test_code, payload)
+rescue PsiEligibility::ApiError => e
+  puts "Exception when calling DefaultApi->update_candidate_eligibility: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_code** | **String**| provided client specific account code. | 
+ **candidate_id** | **String**| The unique candidate id to update. | 
+ **test_code** | **String**| The test code. | 
+ **payload** | [**EligibilityModel**](EligibilityModel.md)| The candidate&#39;s updated eligibity record. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json; charset=UTF-8
+
+
+