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.



990
991
992
# File 'lib/vericred_client/api/formularies_api.rb', line 990

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



988
989
990
# File 'lib/vericred_client/api/formularies_api.rb', line 988

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:



1002
1003
1004
1005
# File 'lib/vericred_client/api/formularies_api.rb', line 1002

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



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'lib/vericred_client/api/formularies_api.rb', line 1015

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