Class: OpenapiClient::SectorApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/sector_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SectorApi

Returns a new instance of SectorApi.



19
20
21
 
# File 'lib/openapi_client/api/sector_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/openapi_client/api/sector_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_sectors(opts = {}) ⇒ Array<Sector>

Returns the valid sectors which can be passed to various other endpoints in the sector field

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# 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

#get_sectors_with_http_info(opts = {}) ⇒ Array<(Array<Sector>, Integer, Hash)>

Returns the valid sectors which can be passed to various other endpoints in the sector field

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<Sector>, Integer, Hash)>) —

    Array<Sector> data, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# 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

#get_top_sectors(date, location, spending_type, opts = {}) ⇒ Array<Array>

Retrieves the top grossing sectors for the specified date & location

Parameters:

  • date (Date) —

    The date for the requested data

  • location (String) —

    The location for which you wish to receive the top-sectors report.

  • spending_type (String) —

    Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)

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

    the optional parameters

Returns:

  • (Array<Array>) 


82
83
84
85
 
# 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

#get_top_sectors_with_http_info(date, location, spending_type, opts = {}) ⇒ Array<(Array<Array>, Integer, Hash)>

Retrieves the top grossing sectors for the specified date &amp; location

Parameters:

  • date (Date) —

    The date for the requested data

  • location (String) —

    The location for which you wish to receive the top-sectors report.

  • spending_type (String) —

    Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)

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

    the optional parameters

Returns:

  • (Array<(Array<Array>, Integer, Hash)>) —

    Array<Array> data, response status code and response headers



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# 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