Class: SwaggerClient::BenchmarkApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/api/benchmark_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BenchmarkApi

Returns a new instance of BenchmarkApi.



19
20
21
 
# File 'lib/nucleus_api/api/benchmark_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/nucleus_api/api/benchmark_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_benchmark_using_post(benchmark, opts = {}) ⇒ Benchmark

Create a benchmark Create a new benchmark for your firm.

Parameters:

  • benchmark —

    benchmark

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

    the optional parameters

Returns:

  • (Benchmark) 


27
28
29
30
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 27

def create_benchmark_using_post(benchmark, opts = {})
  data, _status_code, _headers = create_benchmark_using_post_with_http_info(benchmark, opts)
  data
end

#create_benchmark_using_post_with_http_info(benchmark, opts = {}) ⇒ Array<(Benchmark, Fixnum, Hash)>

Create a benchmark Create a new benchmark for your firm.

Parameters:

  • benchmark —

    benchmark

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

    the optional parameters

Returns:

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

    Benchmark data, response status code and response headers



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
75
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 37

def create_benchmark_using_post_with_http_info(benchmark, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarkApi.create_benchmark_using_post ...'
  end
  # verify the required parameter 'benchmark' is set
  if @api_client.config.client_side_validation && benchmark.nil?
    fail ArgumentError, "Missing the required parameter 'benchmark' when calling BenchmarkApi.create_benchmark_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/benchmark'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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 = @api_client.object_to_http_body(benchmark)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Benchmark')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BenchmarkApi#create_benchmark_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_benchmark_using_delete(benchmark_id, opts = {}) ⇒ nil

Delete a benchmark Permanently delete a benchmark.

Parameters:

  • benchmark_id —

    UUID benchmark_id

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

    the optional parameters

Returns:

  • (nil) 


81
82
83
84
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 81

def delete_benchmark_using_delete(benchmark_id, opts = {})
  delete_benchmark_using_delete_with_http_info(benchmark_id, opts)
  nil
end

#delete_benchmark_using_delete_with_http_info(benchmark_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a benchmark Permanently delete a benchmark.

Parameters:

  • benchmark_id —

    UUID benchmark_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



91
92
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
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 91

def delete_benchmark_using_delete_with_http_info(benchmark_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarkApi.delete_benchmark_using_delete ...'
  end
  # verify the required parameter 'benchmark_id' is set
  if @api_client.config.client_side_validation && benchmark_id.nil?
    fail ArgumentError, "Missing the required parameter 'benchmark_id' when calling BenchmarkApi.delete_benchmark_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/benchmark/{benchmark_id}'.sub('{' + 'benchmark_id' + '}', benchmark_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BenchmarkApi#delete_benchmark_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_benchmark_all_using_get(opts = {}) ⇒ PageBenchmark

List all benchmarks Get details for all benchmarks defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:

  • (PageBenchmark) 


136
137
138
139
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 136

def get_benchmark_all_using_get(opts = {})
  data, _status_code, _headers = get_benchmark_all_using_get_with_http_info(opts)
  data
end

#get_benchmark_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageBenchmark, Fixnum, Hash)>

List all benchmarks Get details for all benchmarks defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageBenchmark data, response status code and response headers



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
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 150

def get_benchmark_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarkApi.get_benchmark_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/benchmark'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'PageBenchmark')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BenchmarkApi#get_benchmark_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_benchmark_asset_size_all_using_get(benchmark_id, opts = {}) ⇒ Array<DateDoubleVO>

List all benchmark asset sizes Get a list of asset sizes by date for a benchmark.

Parameters:

  • benchmark_id —

    UUID benchmark_id

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

    the optional parameters

Options Hash (opts):

  • :end_date (Date) —

    end date

  • :sort_type (String) —

    sort_type

  • :start_date (Date) —

    start date

Returns:

  • (Array<DateDoubleVO>) 


196
197
198
199
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 196

def get_benchmark_asset_size_all_using_get(benchmark_id, opts = {})
  data, _status_code, _headers = get_benchmark_asset_size_all_using_get_with_http_info(benchmark_id, opts)
  data
end

#get_benchmark_asset_size_all_using_get_with_http_info(benchmark_id, opts = {}) ⇒ Array<(Array<DateDoubleVO>, Fixnum, Hash)>

List all benchmark asset sizes Get a list of asset sizes by date for a benchmark.

Parameters:

  • benchmark_id —

    UUID benchmark_id

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

    the optional parameters

Options Hash (opts):

  • :end_date (Date) —

    end date

  • :sort_type (String) —

    sort_type

  • :start_date (Date) —

    start date

Returns:

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

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



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
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 209

def get_benchmark_asset_size_all_using_get_with_http_info(benchmark_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarkApi.get_benchmark_asset_size_all_using_get ...'
  end
  # verify the required parameter 'benchmark_id' is set
  if @api_client.config.client_side_validation && benchmark_id.nil?
    fail ArgumentError, "Missing the required parameter 'benchmark_id' when calling BenchmarkApi.get_benchmark_asset_size_all_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/benchmark/{benchmark_id}/asset_size'.sub('{' + 'benchmark_id' + '}', benchmark_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'sort_type'] = opts[:'sort_type'] if !opts[:'sort_type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'Array<DateDoubleVO>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BenchmarkApi#get_benchmark_asset_size_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_benchmark_using_get(benchmark_id, opts = {}) ⇒ Benchmark

Retrieve a benchmark Retrieve the information for a benchmark.

Parameters:

  • benchmark_id —

    UUID benchmark_id

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

    the optional parameters

Returns:

  • (Benchmark) 


254
255
256
257
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 254

def get_benchmark_using_get(benchmark_id, opts = {})
  data, _status_code, _headers = get_benchmark_using_get_with_http_info(benchmark_id, opts)
  data
end

#get_benchmark_using_get_with_http_info(benchmark_id, opts = {}) ⇒ Array<(Benchmark, Fixnum, Hash)>

Retrieve a benchmark Retrieve the information for a benchmark.

Parameters:

  • benchmark_id —

    UUID benchmark_id

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

    the optional parameters

Returns:

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

    Benchmark data, response status code and response headers



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 264

def get_benchmark_using_get_with_http_info(benchmark_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarkApi.get_benchmark_using_get ...'
  end
  # verify the required parameter 'benchmark_id' is set
  if @api_client.config.client_side_validation && benchmark_id.nil?
    fail ArgumentError, "Missing the required parameter 'benchmark_id' when calling BenchmarkApi.get_benchmark_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/benchmark/{benchmark_id}'.sub('{' + 'benchmark_id' + '}', benchmark_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'Benchmark')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BenchmarkApi#get_benchmark_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_benchmark_using_put(benchmark, benchmark_id, opts = {}) ⇒ Benchmark

Update a benchmark Updated the information for a benchmark.

Parameters:

  • benchmark —

    benchmark

  • benchmark_id —

    UUID benchmark_id

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

    the optional parameters

Returns:

  • (Benchmark) 


307
308
309
310
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 307

def update_benchmark_using_put(benchmark, benchmark_id, opts = {})
  data, _status_code, _headers = update_benchmark_using_put_with_http_info(benchmark, benchmark_id, opts)
  data
end

#update_benchmark_using_put_with_http_info(benchmark, benchmark_id, opts = {}) ⇒ Array<(Benchmark, Fixnum, Hash)>

Update a benchmark Updated the information for a benchmark.

Parameters:

  • benchmark —

    benchmark

  • benchmark_id —

    UUID benchmark_id

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

    the optional parameters

Returns:

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

    Benchmark data, response status code and response headers



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/nucleus_api/api/benchmark_api.rb', line 318

def update_benchmark_using_put_with_http_info(benchmark, benchmark_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarkApi.update_benchmark_using_put ...'
  end
  # verify the required parameter 'benchmark' is set
  if @api_client.config.client_side_validation && benchmark.nil?
    fail ArgumentError, "Missing the required parameter 'benchmark' when calling BenchmarkApi.update_benchmark_using_put"
  end
  # verify the required parameter 'benchmark_id' is set
  if @api_client.config.client_side_validation && benchmark_id.nil?
    fail ArgumentError, "Missing the required parameter 'benchmark_id' when calling BenchmarkApi.update_benchmark_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/benchmark/{benchmark_id}'.sub('{' + 'benchmark_id' + '}', benchmark_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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 = @api_client.object_to_http_body(benchmark)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Benchmark')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BenchmarkApi#update_benchmark_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end