class OpenapiClient::SectorApi
Attributes
Public Class Methods
# File lib/openapi_client/api/sector_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Returns the valid sectors which can be passed to various other endpoints in the sector field @param [Hash] opts the optional parameters @return [Array<Sector>]
# File lib/openapi_client/api/sector_api.rb, line 25 def get_sectors(opts = {}) data, _status_code, _headers = get_sectors_with_http_info(opts) data end
Returns the valid sectors which can be passed to various other endpoints in the sector field @param [Hash] opts the optional parameters @return [Array<(Array<Sector>, Integer, Hash)>] Array<Sector> data, response status code and response headers
# File lib/openapi_client/api/sector_api.rb, line 33 def get_sectors_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SectorApi.get_sectors ...' end # resource path local_var_path = '/sectors' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Array<Sector>' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: SectorApi#get_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves the top grossing sectors for the specified date & location @param date [Date] The date for the requested data @param location [String] The location for which you wish to receive the top-sectors report. @param spending_type [String] Used to distinguish between gross spending (GS) & average transaction value (ATV) @param [Hash] opts the optional parameters @return [Array<Array>]
# File lib/openapi_client/api/sector_api.rb, line 82 def get_top_sectors(date, location, spending_type, opts = {}) data, _status_code, _headers = get_top_sectors_with_http_info(date, location, spending_type, opts) data end
Retrieves the top grossing sectors for the specified date & location @param date [Date] The date for the requested data @param location [String] The location for which you wish to receive the top-sectors report. @param spending_type [String] Used to distinguish between gross spending (GS) & average transaction value (ATV) @param [Hash] opts the optional parameters @return [Array<(Array<Array>, Integer, Hash)>] Array<Array> data, response status code and response headers
# File lib/openapi_client/api/sector_api.rb, line 93 def get_top_sectors_with_http_info(date, location, spending_type, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SectorApi.get_top_sectors ...' end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling SectorApi.get_top_sectors" end # verify the required parameter 'location' is set if @api_client.config.client_side_validation && location.nil? fail ArgumentError, "Missing the required parameter 'location' when calling SectorApi.get_top_sectors" end # verify the required parameter 'spending_type' is set if @api_client.config.client_side_validation && spending_type.nil? fail ArgumentError, "Missing the required parameter 'spending_type' when calling SectorApi.get_top_sectors" end # resource path local_var_path = '/top-sectors' # query parameters query_params = opts[:query_params] || {} query_params[:'date'] = date query_params[:'location'] = location query_params[:'spending_type'] = spending_type # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Array<Array>' # auth_names auth_names = opts[:auth_names] || [] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: SectorApi#get_top_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end