Class: NucleusApi::SecuritiesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SecuritiesApi

Returns a new instance of SecuritiesApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_security_exclusion_using_post(security_exclusion_request, opts = {}) ⇒ SecurityExclusion

Create a security exclusion Create a new security exclusion for a specific account or portfolio.

Parameters:

  • security_exclusion_request —

    securityExclusionRequest

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

    the optional parameters

Returns:



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

def create_security_exclusion_using_post(security_exclusion_request, opts = {})
  data, _status_code, _headers = create_security_exclusion_using_post_with_http_info(security_exclusion_request, opts)
  data
end

#create_security_exclusion_using_post_with_http_info(security_exclusion_request, opts = {}) ⇒ Array<(SecurityExclusion, Fixnum, Hash)>

Create a security exclusion Create a new security exclusion for a specific account or portfolio.

Parameters:

  • security_exclusion_request —

    securityExclusionRequest

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

    the optional parameters

Returns:

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

    SecurityExclusion 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/securities_api.rb', line 37

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

  # 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(security_exclusion_request)
  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 => 'SecurityExclusion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#create_security_exclusion_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_security_price_using_post(security_price_request, opts = {}) ⇒ SecurityPrice

Create a security price Create a new price for a security defined for your firm.

Parameters:

  • security_price_request —

    securityPriceRequest

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

    the optional parameters

Returns:



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

def create_security_price_using_post(security_price_request, opts = {})
  data, _status_code, _headers = create_security_price_using_post_with_http_info(security_price_request, opts)
  data
end

#create_security_price_using_post_with_http_info(security_price_request, opts = {}) ⇒ Array<(SecurityPrice, Fixnum, Hash)>

Create a security price Create a new price for a security defined for your firm.

Parameters:

  • security_price_request —

    securityPriceRequest

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

    the optional parameters

Returns:

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

    SecurityPrice data, 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
127
128
129
 
# File 'lib/nucleus_api/api/securities_api.rb', line 91

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

  # 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(security_price_request)
  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 => 'SecurityPrice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#create_security_price_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_security_using_post(securities_info_request, opts = {}) ⇒ Security

Create a security Create a new security for your firm.

Parameters:

  • securities_info_request —

    securitiesInfoRequest

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/nucleus_api/api/securities_api.rb', line 135

def create_security_using_post(securities_info_request, opts = {})
  data, _status_code, _headers = create_security_using_post_with_http_info(securities_info_request, opts)
  data
end

#create_security_using_post_with_http_info(securities_info_request, opts = {}) ⇒ Array<(Security, Fixnum, Hash)>

Create a security Create a new security for your firm.

Parameters:

  • securities_info_request —

    securitiesInfoRequest

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

    the optional parameters

Returns:

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

    Security data, response status code and response headers



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
176
177
178
179
180
181
182
183
 
# File 'lib/nucleus_api/api/securities_api.rb', line 145

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

  # 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(securities_info_request)
  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 => 'Security')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#create_security_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_security_exclusion_using_delete(security_exclusion_id, opts = {}) ⇒ nil

Delete a security exclusion Permanently delete a security exclusion

Parameters:

  • security_exclusion_id —

    UUID security_exclusion_id

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

    the optional parameters

Returns:

  • (nil) 


189
190
191
192
 
# File 'lib/nucleus_api/api/securities_api.rb', line 189

def delete_security_exclusion_using_delete(security_exclusion_id, opts = {})
  delete_security_exclusion_using_delete_with_http_info(security_exclusion_id, opts)
  nil
end

#delete_security_exclusion_using_delete_with_http_info(security_exclusion_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a security exclusion Permanently delete a security exclusion

Parameters:

  • security_exclusion_id —

    UUID security_exclusion_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_security_exclusion_using_delete_with_http_info(security_exclusion_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.delete_security_exclusion_using_delete ...'
  end
  # verify the required parameter 'security_exclusion_id' is set
  if @api_client.config.client_side_validation && security_exclusion_id.nil?
    fail ArgumentError, "Missing the required parameter 'security_exclusion_id' when calling SecuritiesApi.delete_security_exclusion_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/security_exclusion/{security_exclusion_id}'.sub('{' + 'security_exclusion_id' + '}', security_exclusion_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: SecuritiesApi#delete_security_exclusion_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_security_price_using_delete(security_price_id, opts = {}) ⇒ nil

Delete a security price Permanently delete a security price from a security.

Parameters:

  • security_price_id —

    UUID security_price_id

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

    the optional parameters

Returns:

  • (nil) 


240
241
242
243
 
# File 'lib/nucleus_api/api/securities_api.rb', line 240

def delete_security_price_using_delete(security_price_id, opts = {})
  delete_security_price_using_delete_with_http_info(security_price_id, opts)
  nil
end

#delete_security_price_using_delete_with_http_info(security_price_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a security price Permanently delete a security price from a security.

Parameters:

  • security_price_id —

    UUID security_price_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/nucleus_api/api/securities_api.rb', line 250

def delete_security_price_using_delete_with_http_info(security_price_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.delete_security_price_using_delete ...'
  end
  # verify the required parameter 'security_price_id' is set
  if @api_client.config.client_side_validation && security_price_id.nil?
    fail ArgumentError, "Missing the required parameter 'security_price_id' when calling SecuritiesApi.delete_security_price_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/security_price/{security_price_id}'.sub('{' + 'security_price_id' + '}', security_price_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: SecuritiesApi#delete_security_price_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_security_using_delete(security_id, opts = {}) ⇒ nil

Delete a security Permanently delete a security for your firm.

Parameters:

  • security_id —

    UUID security_id

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

    the optional parameters

Returns:

  • (nil) 


291
292
293
294
 
# File 'lib/nucleus_api/api/securities_api.rb', line 291

def delete_security_using_delete(security_id, opts = {})
  delete_security_using_delete_with_http_info(security_id, opts)
  nil
end

#delete_security_using_delete_with_http_info(security_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a security Permanently delete a security for your firm.

Parameters:

  • security_id —

    UUID security_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/nucleus_api/api/securities_api.rb', line 301

def delete_security_using_delete_with_http_info(security_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.delete_security_using_delete ...'
  end
  # verify the required parameter 'security_id' is set
  if @api_client.config.client_side_validation && security_id.nil?
    fail ArgumentError, "Missing the required parameter 'security_id' when calling SecuritiesApi.delete_security_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/security/{security_id}'.sub('{' + 'security_id' + '}', security_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: SecuritiesApi#delete_security_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_all_using_get(opts = {}) ⇒ PageSecurity

List all securities Get details for all securities 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:



346
347
348
349
 
# File 'lib/nucleus_api/api/securities_api.rb', line 346

def get_security_all_using_get(opts = {})
  data, _status_code, _headers = get_security_all_using_get_with_http_info(opts)
  data
end

#get_security_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageSecurity, Fixnum, Hash)>

List all securities Get details for all securities 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<(PageSecurity, Fixnum, Hash)>) —

    PageSecurity data, response status code and response headers



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/nucleus_api/api/securities_api.rb', line 360

def get_security_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.get_security_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/security'

  # 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 => 'PageSecurity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#get_security_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_exclusion_all_using_get(opts = {}) ⇒ PageSecurityExclusion

List all security exclusions Get details for all security exclusions 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:



407
408
409
410
 
# File 'lib/nucleus_api/api/securities_api.rb', line 407

def get_security_exclusion_all_using_get(opts = {})
  data, _status_code, _headers = get_security_exclusion_all_using_get_with_http_info(opts)
  data
end

#get_security_exclusion_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageSecurityExclusion, Fixnum, Hash)>

List all security exclusions Get details for all security exclusions 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<(PageSecurityExclusion, Fixnum, Hash)>) —

    PageSecurityExclusion data, response status code and response headers



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/nucleus_api/api/securities_api.rb', line 421

def get_security_exclusion_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.get_security_exclusion_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/security_exclusion'

  # 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 => 'PageSecurityExclusion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#get_security_exclusion_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_exclusion_using_get(security_exclusion_id, opts = {}) ⇒ SecurityExclusion

Retrieve a security exclusion Retrieve the information for a security exclusion.

Parameters:

  • security_exclusion_id —

    UUID security_exclusion_id

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

    the optional parameters

Returns:



464
465
466
467
 
# File 'lib/nucleus_api/api/securities_api.rb', line 464

def get_security_exclusion_using_get(security_exclusion_id, opts = {})
  data, _status_code, _headers = get_security_exclusion_using_get_with_http_info(security_exclusion_id, opts)
  data
end

#get_security_exclusion_using_get_with_http_info(security_exclusion_id, opts = {}) ⇒ Array<(SecurityExclusion, Fixnum, Hash)>

Retrieve a security exclusion Retrieve the information for a security exclusion.

Parameters:

  • security_exclusion_id —

    UUID security_exclusion_id

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

    the optional parameters

Returns:

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

    SecurityExclusion data, response status code and response headers



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/nucleus_api/api/securities_api.rb', line 474

def get_security_exclusion_using_get_with_http_info(security_exclusion_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.get_security_exclusion_using_get ...'
  end
  # verify the required parameter 'security_exclusion_id' is set
  if @api_client.config.client_side_validation && security_exclusion_id.nil?
    fail ArgumentError, "Missing the required parameter 'security_exclusion_id' when calling SecuritiesApi.get_security_exclusion_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/security_exclusion/{security_exclusion_id}'.sub('{' + 'security_exclusion_id' + '}', security_exclusion_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 => 'SecurityExclusion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#get_security_exclusion_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_all_using_get(opts = {}) ⇒ PageSecurityPrice

List all security prices Get prices for all securities defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :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:



521
522
523
524
 
# File 'lib/nucleus_api/api/securities_api.rb', line 521

def get_security_price_all_using_get(opts = {})
  data, _status_code, _headers = get_security_price_all_using_get_with_http_info(opts)
  data
end

#get_security_price_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageSecurityPrice, Fixnum, Hash)>

List all security prices Get prices for all securities defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageSecurityPrice data, response status code and response headers



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/nucleus_api/api/securities_api.rb', line 536

def get_security_price_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.get_security_price_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/security_price'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].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 => 'PageSecurityPrice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#get_security_price_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_using_get(security_price_id, opts = {}) ⇒ SecurityPrice

Retrieve a security price Retrieve the information for a security price for a security.

Parameters:

  • security_price_id —

    UUID security_price_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:



581
582
583
584
 
# File 'lib/nucleus_api/api/securities_api.rb', line 581

def get_security_price_using_get(security_price_id, opts = {})
  data, _status_code, _headers = get_security_price_using_get_with_http_info(security_price_id, opts)
  data
end

#get_security_price_using_get_with_http_info(security_price_id, opts = {}) ⇒ Array<(SecurityPrice, Fixnum, Hash)>

Retrieve a security price Retrieve the information for a security price for a security.

Parameters:

  • security_price_id —

    UUID security_price_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:

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

    SecurityPrice data, response status code and response headers



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/nucleus_api/api/securities_api.rb', line 592

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

  # query parameters
  query_params = {}
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].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 => 'SecurityPrice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#get_security_price_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_using_get(security_id, opts = {}) ⇒ Security

Retrieve a security Retrieve the information for a security defined for your firm.

Parameters:

  • security_id —

    UUID security_id

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

    the optional parameters

Returns:



635
636
637
638
 
# File 'lib/nucleus_api/api/securities_api.rb', line 635

def get_security_using_get(security_id, opts = {})
  data, _status_code, _headers = get_security_using_get_with_http_info(security_id, opts)
  data
end

#get_security_using_get_with_http_info(security_id, opts = {}) ⇒ Array<(Security, Fixnum, Hash)>

Retrieve a security Retrieve the information for a security defined for your firm.

Parameters:

  • security_id —

    UUID security_id

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

    the optional parameters

Returns:

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

    Security data, response status code and response headers



645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/nucleus_api/api/securities_api.rb', line 645

def get_security_using_get_with_http_info(security_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.get_security_using_get ...'
  end
  # verify the required parameter 'security_id' is set
  if @api_client.config.client_side_validation && security_id.nil?
    fail ArgumentError, "Missing the required parameter 'security_id' when calling SecuritiesApi.get_security_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/security/{security_id}'.sub('{' + 'security_id' + '}', security_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 => 'Security')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#get_security_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_security_exclusion_using_put(security_exclusion, security_exclusion_id, opts = {}) ⇒ SecurityExclusion

Update a security exclusion Update the information for a security exclusion.

Parameters:

  • security_exclusion —

    security_exclusion

  • security_exclusion_id —

    UUID security_exclusion_id

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

    the optional parameters

Returns:



688
689
690
691
 
# File 'lib/nucleus_api/api/securities_api.rb', line 688

def update_security_exclusion_using_put(security_exclusion, security_exclusion_id, opts = {})
  data, _status_code, _headers = update_security_exclusion_using_put_with_http_info(security_exclusion, security_exclusion_id, opts)
  data
end

#update_security_exclusion_using_put_with_http_info(security_exclusion, security_exclusion_id, opts = {}) ⇒ Array<(SecurityExclusion, Fixnum, Hash)>

Update a security exclusion Update the information for a security exclusion.

Parameters:

  • security_exclusion —

    security_exclusion

  • security_exclusion_id —

    UUID security_exclusion_id

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

    the optional parameters

Returns:

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

    SecurityExclusion data, response status code and response headers



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/nucleus_api/api/securities_api.rb', line 699

def update_security_exclusion_using_put_with_http_info(security_exclusion, security_exclusion_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.update_security_exclusion_using_put ...'
  end
  # verify the required parameter 'security_exclusion' is set
  if @api_client.config.client_side_validation && security_exclusion.nil?
    fail ArgumentError, "Missing the required parameter 'security_exclusion' when calling SecuritiesApi.update_security_exclusion_using_put"
  end
  # verify the required parameter 'security_exclusion_id' is set
  if @api_client.config.client_side_validation && security_exclusion_id.nil?
    fail ArgumentError, "Missing the required parameter 'security_exclusion_id' when calling SecuritiesApi.update_security_exclusion_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/security_exclusion/{security_exclusion_id}'.sub('{' + 'security_exclusion_id' + '}', security_exclusion_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(security_exclusion)
  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 => 'SecurityExclusion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#update_security_exclusion_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_security_price_using_put(security_price, security_price_id, opts = {}) ⇒ SecurityPrice

Update a security price Update a security price for a security.

Parameters:

  • security_price —

    security_price

  • security_price_id —

    UUID security_price_id

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

    the optional parameters

Returns:



748
749
750
751
 
# File 'lib/nucleus_api/api/securities_api.rb', line 748

def update_security_price_using_put(security_price, security_price_id, opts = {})
  data, _status_code, _headers = update_security_price_using_put_with_http_info(security_price, security_price_id, opts)
  data
end

#update_security_price_using_put_with_http_info(security_price, security_price_id, opts = {}) ⇒ Array<(SecurityPrice, Fixnum, Hash)>

Update a security price Update a security price for a security.

Parameters:

  • security_price —

    security_price

  • security_price_id —

    UUID security_price_id

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

    the optional parameters

Returns:

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

    SecurityPrice data, response status code and response headers



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/nucleus_api/api/securities_api.rb', line 759

def update_security_price_using_put_with_http_info(security_price, security_price_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.update_security_price_using_put ...'
  end
  # verify the required parameter 'security_price' is set
  if @api_client.config.client_side_validation && security_price.nil?
    fail ArgumentError, "Missing the required parameter 'security_price' when calling SecuritiesApi.update_security_price_using_put"
  end
  # verify the required parameter 'security_price_id' is set
  if @api_client.config.client_side_validation && security_price_id.nil?
    fail ArgumentError, "Missing the required parameter 'security_price_id' when calling SecuritiesApi.update_security_price_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/security_price/{security_price_id}'.sub('{' + 'security_price_id' + '}', security_price_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(security_price)
  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 => 'SecurityPrice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#update_security_price_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_security_using_put(security, security_id, opts = {}) ⇒ Security

Update a security Update a security for your firm.

Parameters:

  • security —

    security

  • security_id —

    UUID security_id

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

    the optional parameters

Returns:



808
809
810
811
 
# File 'lib/nucleus_api/api/securities_api.rb', line 808

def update_security_using_put(security, security_id, opts = {})
  data, _status_code, _headers = update_security_using_put_with_http_info(security, security_id, opts)
  data
end

#update_security_using_put_with_http_info(security, security_id, opts = {}) ⇒ Array<(Security, Fixnum, Hash)>

Update a security Update a security for your firm.

Parameters:

  • security —

    security

  • security_id —

    UUID security_id

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

    the optional parameters

Returns:

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

    Security data, response status code and response headers



819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/nucleus_api/api/securities_api.rb', line 819

def update_security_using_put_with_http_info(security, security_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecuritiesApi.update_security_using_put ...'
  end
  # verify the required parameter 'security' is set
  if @api_client.config.client_side_validation && security.nil?
    fail ArgumentError, "Missing the required parameter 'security' when calling SecuritiesApi.update_security_using_put"
  end
  # verify the required parameter 'security_id' is set
  if @api_client.config.client_side_validation && security_id.nil?
    fail ArgumentError, "Missing the required parameter 'security_id' when calling SecuritiesApi.update_security_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/security/{security_id}'.sub('{' + 'security_id' + '}', security_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(security)
  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 => 'Security')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecuritiesApi#update_security_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end