Class: SwaggerClient::BusinessApi
- Inherits:
-
Object
- Object
- SwaggerClient::BusinessApi
- Defined in:
- lib/nucleus_api/api/business_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_business_using_post(business_request, opts = {}) ⇒ Business
Create a business Create a new business, or register a new business.
-
#create_business_using_post_with_http_info(business_request, opts = {}) ⇒ Array<(Business, Fixnum, Hash)>
Create a business Create a new business, or register a new business.
-
#delete_business_using_delete(business_id, opts = {}) ⇒ nil
Delete a business Permanently delete a business.
-
#delete_business_using_delete_with_http_info(business_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete a business Permanently delete a business.
-
#get_business_all_using_get(opts = {}) ⇒ PageBusiness
List all business Get details for all business.
-
#get_business_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageBusiness, Fixnum, Hash)>
List all business Get details for all business.
-
#get_business_asset_size_using_get(business_id, opts = {}) ⇒ Array<AvailableDateDoubleVO>
List all business asset sizes Get a list of asset sizes per date for a business.
-
#get_business_asset_size_using_get_with_http_info(business_id, opts = {}) ⇒ Array<(Array<AvailableDateDoubleVO>, Fixnum, Hash)>
List all business asset sizes Get a list of asset sizes per date for a business.
-
#get_business_client_transaction_all_using_get(business_id, opts = {}) ⇒ PagePortfolioTransaction
List all business transactions Get the information for all transactions under all client registered with your business.
-
#get_business_client_transaction_all_using_get_with_http_info(business_id, opts = {}) ⇒ Array<(PagePortfolioTransaction, Fixnum, Hash)>
List all business transactions Get the information for all transactions under all client registered with your business.
-
#get_business_holding_using_get(business_id, opts = {}) ⇒ PagePortfolioHoldingAgg
List all business holdings Get a list of holdings for a business.
-
#get_business_holding_using_get_with_http_info(business_id, opts = {}) ⇒ Array<(PagePortfolioHoldingAgg, Fixnum, Hash)>
List all business holdings Get a list of holdings for a business.
-
#get_business_using_get(business_id, opts = {}) ⇒ Business
Retrieve a business Retrieve the information for a business.
-
#get_business_using_get_with_http_info(business_id, opts = {}) ⇒ Array<(Business, Fixnum, Hash)>
Retrieve a business Retrieve the information for a business.
-
#initialize(api_client = ApiClient.default) ⇒ BusinessApi
constructor
A new instance of BusinessApi.
-
#update_business_using_put(business, business_id, opts = {}) ⇒ Business
Update a business Update the information for a business.
-
#update_business_using_put_with_http_info(business, business_id, opts = {}) ⇒ Array<(Business, Fixnum, Hash)>
Update a business Update the information for a business.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ BusinessApi
Returns a new instance of BusinessApi.
19 20 21 |
# File 'lib/nucleus_api/api/business_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/business_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_business_using_post(business_request, opts = {}) ⇒ Business
Create a business Create a new business, or register a new business.
27 28 29 30 |
# File 'lib/nucleus_api/api/business_api.rb', line 27 def create_business_using_post(business_request, opts = {}) data, _status_code, _headers = create_business_using_post_with_http_info(business_request, opts) data end |
#create_business_using_post_with_http_info(business_request, opts = {}) ⇒ Array<(Business, Fixnum, Hash)>
Create a business Create a new business, or register a new business.
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/business_api.rb', line 37 def create_business_using_post_with_http_info(business_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BusinessApi.create_business_using_post ...' end # verify the required parameter 'business_request' is set if @api_client.config.client_side_validation && business_request.nil? fail ArgumentError, "Missing the required parameter 'business_request' when calling BusinessApi.create_business_using_post" end # resource path local_var_path = '/nucleus/v1/business' # 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(business_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 => 'Business') if @api_client.config.debugging @api_client.config.logger.debug "API called: BusinessApi#create_business_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_business_using_delete(business_id, opts = {}) ⇒ nil
Delete a business Permanently delete a business.
81 82 83 84 |
# File 'lib/nucleus_api/api/business_api.rb', line 81 def delete_business_using_delete(business_id, opts = {}) delete_business_using_delete_with_http_info(business_id, opts) nil end |
#delete_business_using_delete_with_http_info(business_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete a business Permanently delete a business.
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/business_api.rb', line 91 def delete_business_using_delete_with_http_info(business_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BusinessApi.delete_business_using_delete ...' end # verify the required parameter 'business_id' is set if @api_client.config.client_side_validation && business_id.nil? fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessApi.delete_business_using_delete" end # resource path local_var_path = '/nucleus/v1/business/{business_id}'.sub('{' + 'business_id' + '}', business_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: BusinessApi#delete_business_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_business_all_using_get(opts = {}) ⇒ PageBusiness
List all business Get details for all business.
136 137 138 139 |
# File 'lib/nucleus_api/api/business_api.rb', line 136 def get_business_all_using_get(opts = {}) data, _status_code, _headers = get_business_all_using_get_with_http_info(opts) data end |
#get_business_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageBusiness, Fixnum, Hash)>
List all business Get details for all business.
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/business_api.rb', line 150 def get_business_all_using_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BusinessApi.get_business_all_using_get ...' end # resource path local_var_path = '/nucleus/v1/business' # 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 => 'PageBusiness') if @api_client.config.debugging @api_client.config.logger.debug "API called: BusinessApi#get_business_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_business_asset_size_using_get(business_id, opts = {}) ⇒ Array<AvailableDateDoubleVO>
List all business asset sizes Get a list of asset sizes per date for a business.
199 200 201 202 |
# File 'lib/nucleus_api/api/business_api.rb', line 199 def get_business_asset_size_using_get(business_id, opts = {}) data, _status_code, _headers = get_business_asset_size_using_get_with_http_info(business_id, opts) data end |
#get_business_asset_size_using_get_with_http_info(business_id, opts = {}) ⇒ Array<(Array<AvailableDateDoubleVO>, Fixnum, Hash)>
List all business asset sizes Get a list of asset sizes per date for a business.
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 251 252 253 254 255 256 257 |
# File 'lib/nucleus_api/api/business_api.rb', line 215 def get_business_asset_size_using_get_with_http_info(business_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BusinessApi.get_business_asset_size_using_get ...' end # verify the required parameter 'business_id' is set if @api_client.config.client_side_validation && business_id.nil? fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessApi.get_business_asset_size_using_get" end # resource path local_var_path = '/nucleus/v1/business/{business_id}/asset_size'.sub('{' + 'business_id' + '}', business_id.to_s) # query parameters query_params = {} query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil? query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil? query_params[:'exclude_subledger'] = opts[:'exclude_subledger'] if !opts[:'exclude_subledger'].nil? query_params[:'get_latest'] = opts[:'get_latest'] if !opts[:'get_latest'].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<AvailableDateDoubleVO>') if @api_client.config.debugging @api_client.config.logger.debug "API called: BusinessApi#get_business_asset_size_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_business_client_transaction_all_using_get(business_id, opts = {}) ⇒ PagePortfolioTransaction
List all business transactions Get the information for all transactions under all client registered with your business.
271 272 273 274 |
# File 'lib/nucleus_api/api/business_api.rb', line 271 def get_business_client_transaction_all_using_get(business_id, opts = {}) data, _status_code, _headers = get_business_client_transaction_all_using_get_with_http_info(business_id, opts) data end |
#get_business_client_transaction_all_using_get_with_http_info(business_id, opts = {}) ⇒ Array<(PagePortfolioTransaction, Fixnum, Hash)>
List all business transactions Get the information for all transactions under all client registered with your business.
289 290 291 292 293 294 295 296 297 298 299 300 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 |
# File 'lib/nucleus_api/api/business_api.rb', line 289 def get_business_client_transaction_all_using_get_with_http_info(business_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BusinessApi.get_business_client_transaction_all_using_get ...' end # verify the required parameter 'business_id' is set if @api_client.config.client_side_validation && business_id.nil? fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessApi.get_business_client_transaction_all_using_get" end # resource path local_var_path = '/nucleus/v1/business/{business_id}/transaction'.sub('{' + 'business_id' + '}', business_id.to_s) # 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[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].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? 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 => 'PagePortfolioTransaction') if @api_client.config.debugging @api_client.config.logger.debug "API called: BusinessApi#get_business_client_transaction_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_business_holding_using_get(business_id, opts = {}) ⇒ PagePortfolioHoldingAgg
List all business holdings Get a list of holdings for a business.
348 349 350 351 |
# File 'lib/nucleus_api/api/business_api.rb', line 348 def get_business_holding_using_get(business_id, opts = {}) data, _status_code, _headers = get_business_holding_using_get_with_http_info(business_id, opts) data end |
#get_business_holding_using_get_with_http_info(business_id, opts = {}) ⇒ Array<(PagePortfolioHoldingAgg, Fixnum, Hash)>
List all business holdings Get a list of holdings for a business.
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 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 |
# File 'lib/nucleus_api/api/business_api.rb', line 367 def get_business_holding_using_get_with_http_info(business_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BusinessApi.get_business_holding_using_get ...' end # verify the required parameter 'business_id' is set if @api_client.config.client_side_validation && business_id.nil? fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessApi.get_business_holding_using_get" end # resource path local_var_path = '/nucleus/v1/business/{business_id}/holding'.sub('{' + 'business_id' + '}', business_id.to_s) # 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[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'get_latest'] = opts[:'get_latest'] if !opts[:'get_latest'].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? 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 => 'PagePortfolioHoldingAgg') if @api_client.config.debugging @api_client.config.logger.debug "API called: BusinessApi#get_business_holding_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_business_using_get(business_id, opts = {}) ⇒ Business
Retrieve a business Retrieve the information for a business.
418 419 420 421 |
# File 'lib/nucleus_api/api/business_api.rb', line 418 def get_business_using_get(business_id, opts = {}) data, _status_code, _headers = get_business_using_get_with_http_info(business_id, opts) data end |
#get_business_using_get_with_http_info(business_id, opts = {}) ⇒ Array<(Business, Fixnum, Hash)>
Retrieve a business Retrieve the information for a business.
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 459 460 461 462 463 464 |
# File 'lib/nucleus_api/api/business_api.rb', line 428 def get_business_using_get_with_http_info(business_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BusinessApi.get_business_using_get ...' end # verify the required parameter 'business_id' is set if @api_client.config.client_side_validation && business_id.nil? fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessApi.get_business_using_get" end # resource path local_var_path = '/nucleus/v1/business/{business_id}'.sub('{' + 'business_id' + '}', business_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 => 'Business') if @api_client.config.debugging @api_client.config.logger.debug "API called: BusinessApi#get_business_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_business_using_put(business, business_id, opts = {}) ⇒ Business
Update a business Update the information for a business.
471 472 473 474 |
# File 'lib/nucleus_api/api/business_api.rb', line 471 def update_business_using_put(business, business_id, opts = {}) data, _status_code, _headers = update_business_using_put_with_http_info(business, business_id, opts) data end |
#update_business_using_put_with_http_info(business, business_id, opts = {}) ⇒ Array<(Business, Fixnum, Hash)>
Update a business Update the information for a business.
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 511 512 513 514 515 516 517 518 519 520 521 522 523 524 |
# File 'lib/nucleus_api/api/business_api.rb', line 482 def update_business_using_put_with_http_info(business, business_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BusinessApi.update_business_using_put ...' end # verify the required parameter 'business' is set if @api_client.config.client_side_validation && business.nil? fail ArgumentError, "Missing the required parameter 'business' when calling BusinessApi.update_business_using_put" end # verify the required parameter 'business_id' is set if @api_client.config.client_side_validation && business_id.nil? fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessApi.update_business_using_put" end # resource path local_var_path = '/nucleus/v1/business/{business_id}'.sub('{' + 'business_id' + '}', business_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(business) 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 => 'Business') if @api_client.config.debugging @api_client.config.logger.debug "API called: BusinessApi#update_business_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |