class Beanie::CompanyApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/beanie/api/company_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

find_company_by_id(id, opts = {}) click to toggle source

Find Company details by ID Returns a single company details if the user has access @param id ID of company details to fetch @param [Hash] opts the optional parameters @return [Company]

# File lib/beanie/api/company_api.rb, line 27
def find_company_by_id(id, opts = {})
  data, _status_code, _headers = find_company_by_id_with_http_info(id, opts)
  data
end
find_company_by_id_with_http_info(id, opts = {}) click to toggle source

Find Company details by ID Returns a single company details if the user has access @param id ID of company details to fetch @param [Hash] opts the optional parameters @return [Array<(Company, Fixnum, Hash)>] Company data, response status code and response headers

# File lib/beanie/api/company_api.rb, line 37
def find_company_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanyApi.find_company_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CompanyApi.find_company_by_id"
  end
  # resource path
  local_var_path = '/companies/{id}'.sub('{' + 'id' + '}', 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'])
  # 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 = nil
  auth_names = ['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 => 'Company')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#find_company_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end