Class: VericredClient::FormulariesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vericred_client/api/formularies_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FormulariesApi

Returns a new instance of FormulariesApi.



1018
1019
1020
 
# File 'lib/vericred_client/api/formularies_api.rb', line 1018

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



1016
1017
1018
 
# File 'lib/vericred_client/api/formularies_api.rb', line 1016

def api_client
  @api_client
end

Instance Method Details

#list_formularies(opts = {}) ⇒ FormularyResponse

Formulary Search Search for drugs by proprietary name

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :search_term (String) —

    Full or partial name of the formulary

  • :rx_bin (String) —

    RX BIN Number (found on an insurance card)

  • :rx_group (String) —

    RX Group String (found on an insurance card)

  • :rx_pcn (String) —

    RX PCN Number (found on an insurance card)

Returns:



1030
1031
1032
1033
 
# File 'lib/vericred_client/api/formularies_api.rb', line 1030

def list_formularies(opts = {})
  data, _status_code, _headers = list_formularies_with_http_info(opts)
  return data
end

#list_formularies_with_http_info(opts = {}) ⇒ Array<(FormularyResponse, Fixnum, Hash)>

Formulary Search Search for drugs by proprietary name

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :search_term (String) —

    Full or partial name of the formulary

  • :rx_bin (String) —

    RX BIN Number (found on an insurance card)

  • :rx_group (String) —

    RX Group String (found on an insurance card)

  • :rx_pcn (String) —

    RX PCN Number (found on an insurance card)

Returns:

  • (Array<(FormularyResponse, Fixnum, Hash)>) —

    FormularyResponse data, response status code and response headers



1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
 
# File 'lib/vericred_client/api/formularies_api.rb', line 1043

def list_formularies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormulariesApi.list_formularies ..."
  end
  # resource path
  local_var_path = "/formularies".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'search_term'] = opts[:'search_term'] if !opts[:'search_term'].nil?
  query_params[:'rx_bin'] = opts[:'rx_bin'] if !opts[:'rx_bin'].nil?
  query_params[:'rx_group'] = opts[:'rx_group'] if !opts[:'rx_group'].nil?
  query_params[:'rx_pcn'] = opts[:'rx_pcn'] if !opts[:'rx_pcn'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Vericred-Api-Key']
  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 => 'FormularyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormulariesApi#list_formularies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_formulary_drug_package_coverage(formulary_id, ndc_package_code, opts = {}) ⇒ FormularyDrugPackageResponse

Formulary Drug Package Search Search for coverage by Formulary and DrugPackage ID

Parameters:

  • formulary_id —

    ID of the Formulary in question

  • ndc_package_code —

    ID of the DrugPackage in question

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1093
1094
1095
1096
 
# File 'lib/vericred_client/api/formularies_api.rb', line 1093

def show_formulary_drug_package_coverage(formulary_id, ndc_package_code, opts = {})
  data, _status_code, _headers = show_formulary_drug_package_coverage_with_http_info(formulary_id, ndc_package_code, opts)
  return data
end

#show_formulary_drug_package_coverage_with_http_info(formulary_id, ndc_package_code, opts = {}) ⇒ Array<(FormularyDrugPackageResponse, Fixnum, Hash)>

Formulary Drug Package Search Search for coverage by Formulary and DrugPackage ID

Parameters:

  • formulary_id —

    ID of the Formulary in question

  • ndc_package_code —

    ID of the DrugPackage in question

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/vericred_client/api/formularies_api.rb', line 1104

def show_formulary_drug_package_coverage_with_http_info(formulary_id, ndc_package_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormulariesApi.show_formulary_drug_package_coverage ..."
  end
  # verify the required parameter 'formulary_id' is set
  fail ArgumentError, "Missing the required parameter 'formulary_id' when calling FormulariesApi.show_formulary_drug_package_coverage" if formulary_id.nil?
  # verify the required parameter 'ndc_package_code' is set
  fail ArgumentError, "Missing the required parameter 'ndc_package_code' when calling FormulariesApi.show_formulary_drug_package_coverage" if ndc_package_code.nil?
  # resource path
  local_var_path = "/formularies/{formulary_id}/drug_packages/{ndc_package_code}".sub('{format}','json').sub('{' + 'formulary_id' + '}', formulary_id.to_s).sub('{' + 'ndc_package_code' + '}', ndc_package_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Vericred-Api-Key']
  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 => 'FormularyDrugPackageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormulariesApi#show_formulary_drug_package_coverage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end