Class: OpenapiClient::ReportsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReportsApi

Returns a new instance of ReportsApi.



19
20
21
 
# File 'lib/openapi_client/api/reports_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/reports_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_spending(date, location, spending_type, opts = {}) ⇒ SpendingReport

Retrieves e-commerce spending for a particular location, sector and date range or single date

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) & average transaction value (ATV)

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

    the optional parameters

Options Hash (opts):

  • :sector (Integer) —

    The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call

Returns:



29
30
31
32
 
# File 'lib/openapi_client/api/reports_api.rb', line 29

def get_spending(date, location, spending_type, opts = {})
  data, _status_code, _headers = get_spending_with_http_info(date, location, spending_type, opts)
  data
end

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

Retrieves e-commerce spending for a particular location, sector and date range or single date

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

Options Hash (opts):

  • :sector (Integer) —

    The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call

Returns:

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

    SpendingReport data, response status code and response headers



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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/openapi_client/api/reports_api.rb', line 41

def get_spending_with_http_info(date, location, spending_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.get_spending ...'
  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 ReportsApi.get_spending"
  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 ReportsApi.get_spending"
  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 ReportsApi.get_spending"
  end
  # resource path
  local_var_path = '/spending-reports'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'date'] = date
  query_params[:'location'] = location
  query_params[:'spending_type'] = spending_type
  query_params[:'sector'] = opts[:'sector'] if !opts[:'sector'].nil?

  # 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] || 'SpendingReport' 

  # 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: ReportsApi#get_spending\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_top_locations(date, spending_type, opts = {}) ⇒ TopLocationsReport

Retrieves the top grossing locations for the specified date/sector/spending type

Parameters:

  • date (Date) —

    The date for the requested data

  • spending_type (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :sector (Integer) —

    The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call

  • :limit (Integer) —

    Can be used to limit the amount of results returned from a query (Pagination)

  • :offset (Integer) —

    The number of items to offset the start of the list from (Pagination)

Returns:



108
109
110
111
 
# File 'lib/openapi_client/api/reports_api.rb', line 108

def get_top_locations(date, spending_type, opts = {})
  data, _status_code, _headers = get_top_locations_with_http_info(date, spending_type, opts)
  data
end

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

Retrieves the top grossing locations for the specified date/sector/spending type

Parameters:

  • date (Date) —

    The date for the requested data

  • spending_type (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :sector (Integer) —

    The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call

  • :limit (Integer) —

    Can be used to limit the amount of results returned from a query (Pagination)

  • :offset (Integer) —

    The number of items to offset the start of the list from (Pagination)

Returns:

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

    TopLocationsReport data, response status code and response headers



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/openapi_client/api/reports_api.rb', line 121

def get_top_locations_with_http_info(date, spending_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.get_top_locations ...'
  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 ReportsApi.get_top_locations"
  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 ReportsApi.get_top_locations"
  end
  # resource path
  local_var_path = '/top-locations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'date'] = date
  query_params[:'spending_type'] = spending_type
  query_params[:'sector'] = opts[:'sector'] if !opts[:'sector'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # 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] || 'TopLocationsReport' 

  # 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: ReportsApi#get_top_locations\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>) 


183
184
185
186
 
# File 'lib/openapi_client/api/reports_api.rb', line 183

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/openapi_client/api/reports_api.rb', line 194

def get_top_sectors_with_http_info(date, location, spending_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.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 ReportsApi.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 ReportsApi.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 ReportsApi.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: ReportsApi#get_top_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end