psi_eligibility 1.0.1

data/docs/EligibilityModel.md

@@ -0,0 +1,13 @@
+# PsiEligibility::EligibilityModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eligibility_end_date** | **String** | The last date possible for the candidate to schedule on. Java ISO_OFFSET_DATE_TIME format. Required when creating a new eligibility. | [optional] 
+**candidate** | [**CandidateModel**](CandidateModel.md) |  | 
+**portion_codes** | **Array<String>** | If required, specific portion codes may be supplied. | [optional] 
+**schedule_start_date** | **String** | The first date possible for the candidate to schedule on. Java ISO_OFFSET_DATE_TIME format. Required when creating a new eligibility. | [optional] 
+**test_code** | **String** | The client specific test code for the eligibility to be created against. | 
+**client_eligibility_id** | **String** | Client provided unique key for this eligibility. | [optional] 
+
+

data/docs/EligibilityResponseModel.md

@@ -0,0 +1,8 @@
+# PsiEligibility::EligibilityResponseModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**psi_eligiblity_id** | **String** | The eligibility identifier. | [optional] 
+
+

data/docs/ErrorModel.md

@@ -0,0 +1,9 @@
+# PsiEligibility::ErrorModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_description** | **String** | Error Description. | [optional] 
+**error** | **String** | Error Code. | [optional] 
+
+

data/docs/ExistingEligibilityModel.md

@@ -0,0 +1,18 @@
+# PsiEligibility::ExistingEligibilityModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eligibility_end_date** | **String** | The last date possible for the candidate to schedule on. Java ISO_OFFSET_DATE_TIME format. | [optional] 
+**candidate** | [**CandidateModel**](CandidateModel.md) |  | [optional] 
+**portion_codes** | **Array<String>** | If required, specific portion codes may be supplied. | [optional] 
+**schedule_start_date** | **String** | The first date possible for the candidate to schedule on. Java ISO_OFFSET_DATE_TIME format. | [optional] 
+**eligibility_status_message** | **String** | Any pertinent message about why a candidate is not eligibile to scheduled yet. Common reasons can be because they have been blocked, have pending special accommodations or other similar reasons. Will be null if candidate is eligible to schedule. | [optional] 
+**test_code** | **String** | The client specific test code for the eligibility to be created against. | [optional] 
+**eligible_to_schedule** | **BOOLEAN** | Whether or not this candidate is eligibile to be scheduled. | [optional] 
+**psi_eligiblity_id** | **String** | PSI's unique identifier for this eligibility. | [optional] 
+**created_datetime** | **String** | Datetime when the eligibility was created. ISO 8601 format similar to  Java ISO_OFFSET_DATE_TIME format. | [optional] 
+**client_eligibility_id** | **String** | Client's unique identifier for this eligibility if provided. | [optional] 
+**status** | **String** | Only set on this object when returned back to client. Setting this has no effect when provided as part of a create or update. This is the 4 different eligibility statuses available for a candidate: REG01 is Registration Pending, REG02 is Registration approved, REG03 is Cancelled, REG04 is Scheduled | [optional] 
+
+

data/docs/TestLaunchInfoModel.md

@@ -0,0 +1,8 @@
+# PsiEligibility::TestLaunchInfoModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test_launch_url** | **String** |  | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id=""
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id=""
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note=""
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/psi_eligibility.rb

@@ -0,0 +1,47 @@
+=begin
+#PSI Candidate Rest Eligibility Service
+
+#PSIs REST based service to modify candidate test eligibilities.
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.10
+
+=end
+
+# Common files
+require 'psi_eligibility/api_client'
+require 'psi_eligibility/api_error'
+require 'psi_eligibility/version'
+require 'psi_eligibility/configuration'
+
+# Models
+require 'psi_eligibility/models/additional_attribute_model'
+require 'psi_eligibility/models/candidate_model'
+require 'psi_eligibility/models/eligibility_model'
+require 'psi_eligibility/models/eligibility_response_model'
+require 'psi_eligibility/models/error_model'
+require 'psi_eligibility/models/existing_eligibility_model'
+require 'psi_eligibility/models/test_launch_info_model'
+
+# APIs
+require 'psi_eligibility/api/default_api'
+
+module PsiEligibility
+  class << self
+    # Customize default settings for the SDK using block.
+    #   PsiEligibility.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/psi_eligibility/api/default_api.rb

@@ -0,0 +1,454 @@
+=begin
+#PSI Candidate Rest Eligibility Service
+
+#PSIs REST based service to modify candidate test eligibilities.
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.10
+
+=end
+
+require 'uri'
+
+module PsiEligibility
+  class DefaultApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Cancel a candidate's eligibility record.
+    # Cancels the eligibility matching the supplied candidate eligiblity code.
+    # @param account_code provided client specific account code.
+    # @param candidate_id The unique candidate id to act on.
+    # @param test_code The test code.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def cancel_candidate_eligibility(account_code, candidate_id, test_code, opts = {})
+      cancel_candidate_eligibility_with_http_info(account_code, candidate_id, test_code, opts)
+      nil
+    end
+
+    # Cancel a candidate's eligibility record.
+    # Cancels the eligibility matching the supplied candidate eligiblity code.
+    # @param account_code provided client specific account code.
+    # @param candidate_id The unique candidate id to act on.
+    # @param test_code The test code.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def cancel_candidate_eligibility_with_http_info(account_code, candidate_id, test_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.cancel_candidate_eligibility ...'
+      end
+      # verify the required parameter 'account_code' is set
+      if @api_client.config.client_side_validation && account_code.nil?
+        fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.cancel_candidate_eligibility"
+      end
+      # verify the required parameter 'candidate_id' is set
+      if @api_client.config.client_side_validation && candidate_id.nil?
+        fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.cancel_candidate_eligibility"
+      end
+      # verify the required parameter 'test_code' is set
+      if @api_client.config.client_side_validation && test_code.nil?
+        fail ArgumentError, "Missing the required parameter 'test_code' when calling DefaultApi.cancel_candidate_eligibility"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}'.sub('{' + 'account_code' + '}', account_code.to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s).sub('{' + 'test_code' + '}', test_code.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#cancel_candidate_eligibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Create a new candidate eligibility record.
+    # Submits a single eligibilites to the PSI Atlas system. Many parameters are optional but the more the better.
+    # @param account_code provided client specific account code.
+    # @param payload A new eligibility record.
+    # @param [Hash] opts the optional parameters
+    # @return [EligibilityResponseModel]
+    def create_candidate(account_code, payload, opts = {})
+      data, _status_code, _headers = create_candidate_with_http_info(account_code, payload, opts)
+      data
+    end
+
+    # Create a new candidate eligibility record.
+    # Submits a single eligibilites to the PSI Atlas system. Many parameters are optional but the more the better.
+    # @param account_code provided client specific account code.
+    # @param payload A new eligibility record.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EligibilityResponseModel, Fixnum, Hash)>] EligibilityResponseModel data, response status code and response headers
+    def create_candidate_with_http_info(account_code, payload, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.create_candidate ...'
+      end
+      # verify the required parameter 'account_code' is set
+      if @api_client.config.client_side_validation && account_code.nil?
+        fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.create_candidate"
+      end
+      # verify the required parameter 'payload' is set
+      if @api_client.config.client_side_validation && payload.nil?
+        fail ArgumentError, "Missing the required parameter 'payload' when calling DefaultApi.create_candidate"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_code}/candidates'.sub('{' + 'account_code' + '}', account_code.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=UTF-8'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(payload)
+      auth_names = ['oauth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EligibilityResponseModel')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#create_candidate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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.
+    # @param account_code provided client specific account code.
+    # @param candidate_id the candidate id.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<ExistingEligibilityModel>]
+    def get_candidate(account_code, candidate_id, opts = {})
+      data, _status_code, _headers = get_candidate_with_http_info(account_code, candidate_id, opts)
+      data
+    end
+
+    # Get the eligiblities associated with the candidate id.
+    # Get&#39;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.
+    # @param account_code provided client specific account code.
+    # @param candidate_id the candidate id.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<ExistingEligibilityModel>, Fixnum, Hash)>] Array<ExistingEligibilityModel> data, response status code and response headers
+    def get_candidate_with_http_info(account_code, candidate_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_candidate ...'
+      end
+      # verify the required parameter 'account_code' is set
+      if @api_client.config.client_side_validation && account_code.nil?
+        fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.get_candidate"
+      end
+      # verify the required parameter 'candidate_id' is set
+      if @api_client.config.client_side_validation && candidate_id.nil?
+        fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.get_candidate"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_code}/candidates/{candidate_id}'.sub('{' + 'account_code' + '}', account_code.to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<ExistingEligibilityModel>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_candidate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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.
+    # @param account_code provided client specific account code.
+    # @param candidate_id the candidate id.
+    # @param test_code The test code.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<ExistingEligibilityModel>]
+    def get_candidate_eligibilities(account_code, candidate_id, test_code, opts = {})
+      data, _status_code, _headers = get_candidate_eligibilities_with_http_info(account_code, candidate_id, test_code, opts)
+      data
+    end
+
+    # Get the eligiblities associated with the candidate id.
+    # Get&#39;s all of the eligibilities associated with the supplied candidate_id fpr a specific test code.
+    # @param account_code provided client specific account code.
+    # @param candidate_id the candidate id.
+    # @param test_code The test code.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<ExistingEligibilityModel>, Fixnum, Hash)>] Array<ExistingEligibilityModel> data, response status code and response headers
+    def get_candidate_eligibilities_with_http_info(account_code, candidate_id, test_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_candidate_eligibilities ...'
+      end
+      # verify the required parameter 'account_code' is set
+      if @api_client.config.client_side_validation && account_code.nil?
+        fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.get_candidate_eligibilities"
+      end
+      # verify the required parameter 'candidate_id' is set
+      if @api_client.config.client_side_validation && candidate_id.nil?
+        fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.get_candidate_eligibilities"
+      end
+      # verify the required parameter 'test_code' is set
+      if @api_client.config.client_side_validation && test_code.nil?
+        fail ArgumentError, "Missing the required parameter 'test_code' when calling DefaultApi.get_candidate_eligibilities"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}'.sub('{' + 'account_code' + '}', account_code.to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s).sub('{' + 'test_code' + '}', test_code.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<ExistingEligibilityModel>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_candidate_eligibilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # GET test launch url
+    # API endpoint to retrieve the test launch URL for a given eligibility code.
+    # @param psi_eligibility_code 
+    # @param [Hash] opts the optional parameters
+    # @return [TestLaunchInfoModel]
+    def get_test_launch_info(psi_eligibility_code, opts = {})
+      data, _status_code, _headers = get_test_launch_info_with_http_info(psi_eligibility_code, opts)
+      data
+    end
+
+    # GET test launch url
+    # API endpoint to retrieve the test launch URL for a given eligibility code.
+    # @param psi_eligibility_code 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TestLaunchInfoModel, Fixnum, Hash)>] TestLaunchInfoModel data, response status code and response headers
+    def get_test_launch_info_with_http_info(psi_eligibility_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_test_launch_info ...'
+      end
+      # verify the required parameter 'psi_eligibility_code' is set
+      if @api_client.config.client_side_validation && psi_eligibility_code.nil?
+        fail ArgumentError, "Missing the required parameter 'psi_eligibility_code' when calling DefaultApi.get_test_launch_info"
+      end
+      # resource path
+      local_var_path = '/eligibilities/{psi_eligibility_code}/testLaunchInfo'.sub('{' + 'psi_eligibility_code' + '}', psi_eligibility_code.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TestLaunchInfoModel')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_test_launch_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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)
+    # @param account_code Account code or the customer code
+    # @param candidate_id Candidate Id
+    # @param test_code Test Code
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :payload Voucher Codes to be applied to the candidate&#39;s specified exam record
+    # @return [nil]
+    def modify_vouchers_of_eligibility(account_code, candidate_id, test_code, opts = {})
+      modify_vouchers_of_eligibility_with_http_info(account_code, candidate_id, test_code, opts)
+      nil
+    end
+
+    # 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)
+    # @param account_code Account code or the customer code
+    # @param candidate_id Candidate Id
+    # @param test_code Test Code
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :payload Voucher Codes to be applied to the candidate&#39;s specified exam record
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def modify_vouchers_of_eligibility_with_http_info(account_code, candidate_id, test_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.modify_vouchers_of_eligibility ...'
+      end
+      # verify the required parameter 'account_code' is set
+      if @api_client.config.client_side_validation && account_code.nil?
+        fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.modify_vouchers_of_eligibility"
+      end
+      # verify the required parameter 'candidate_id' is set
+      if @api_client.config.client_side_validation && candidate_id.nil?
+        fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.modify_vouchers_of_eligibility"
+      end
+      # verify the required parameter 'test_code' is set
+      if @api_client.config.client_side_validation && test_code.nil?
+        fail ArgumentError, "Missing the required parameter 'test_code' when calling DefaultApi.modify_vouchers_of_eligibility"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}/vouchers'.sub('{' + 'account_code' + '}', account_code.to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s).sub('{' + 'test_code' + '}', test_code.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'payload'])
+      auth_names = ['oauth']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#modify_vouchers_of_eligibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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.
+    # @param account_code provided client specific account code.
+    # @param candidate_id The unique candidate id to update.
+    # @param test_code The test code.
+    # @param payload The candidate&#39;s updated eligibity record.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_candidate_eligibility(account_code, candidate_id, test_code, payload, opts = {})
+      update_candidate_eligibility_with_http_info(account_code, candidate_id, test_code, payload, opts)
+      nil
+    end
+
+    # Update an existing candidate&#39;s eligibility record.
+    # Update an existing candidate&#39;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.
+    # @param account_code provided client specific account code.
+    # @param candidate_id The unique candidate id to update.
+    # @param test_code The test code.
+    # @param payload The candidate&#39;s updated eligibity record.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_candidate_eligibility_with_http_info(account_code, candidate_id, test_code, payload, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.update_candidate_eligibility ...'
+      end
+      # verify the required parameter 'account_code' is set
+      if @api_client.config.client_side_validation && account_code.nil?
+        fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.update_candidate_eligibility"
+      end
+      # verify the required parameter 'candidate_id' is set
+      if @api_client.config.client_side_validation && candidate_id.nil?
+        fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.update_candidate_eligibility"
+      end
+      # verify the required parameter 'test_code' is set
+      if @api_client.config.client_side_validation && test_code.nil?
+        fail ArgumentError, "Missing the required parameter 'test_code' when calling DefaultApi.update_candidate_eligibility"
+      end
+      # verify the required parameter 'payload' is set
+      if @api_client.config.client_side_validation && payload.nil?
+        fail ArgumentError, "Missing the required parameter 'payload' when calling DefaultApi.update_candidate_eligibility"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}'.sub('{' + 'account_code' + '}', account_code.to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s).sub('{' + 'test_code' + '}', test_code.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(payload)
+      auth_names = ['oauth']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#update_candidate_eligibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end