Class: VericredClient::SpecialtiesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SpecialtiesApi

Returns a new instance of SpecialtiesApi.



1018
1019
1020
 
# File 'lib/vericred_client/api/specialties_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/specialties_api.rb', line 1016

def api_client
  @api_client
end

Instance Method Details

#get_specialties(opts = {}) ⇒ SpecialtySearchResponse

Specialty Search Use this endpoint to find provider specialties. These specialties can be used to filter providers in the Provider Search.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_term (String) —

    Full or partial name of a specialty or subspecialty

  • :code (String) —

    CMS Healthcare Provider Taxonomy Code

  • :page (Integer) —

    Page of paginated response

  • :per_page (Integer) —

    Responses per page

Returns:



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

def get_specialties(opts = {})
  data, _status_code, _headers = get_specialties_with_http_info(opts)
  return data
end

#get_specialties_with_http_info(opts = {}) ⇒ Array<(SpecialtySearchResponse, Fixnum, Hash)>

Specialty Search Use this endpoint to find provider specialties. These specialties can be used to filter providers in the Provider Search.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_term (String) —

    Full or partial name of a specialty or subspecialty

  • :code (String) —

    CMS Healthcare Provider Taxonomy Code

  • :page (Integer) —

    Page of paginated response

  • :per_page (Integer) —

    Responses per page

Returns:

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

    SpecialtySearchResponse 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/specialties_api.rb', line 1043

def get_specialties_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SpecialtiesApi.get_specialties ..."
  end
  # resource path
  local_var_path = "/specialties".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'search_term'] = opts[:'search_term'] if !opts[:'search_term'].nil?
  query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  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 = []
  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 => 'SpecialtySearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpecialtiesApi#get_specialties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end