nucleus_api 1.8.0

data/docs/BenchmarkComposition.md

@@ -0,0 +1,9 @@
+# NucleusApi::BenchmarkComposition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**security_id** | **String** | securityId | 
+**weight** | **Float** | weight | 
+
+

data/docs/Brokers.md

@@ -0,0 +1,9 @@
+# NucleusApi::Brokers
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**broker_name** | **String** | broker_name | 
+**status** | **String** | status | 
+
+

data/docs/Budget.md

@@ -0,0 +1,25 @@
+# NucleusApi::Budget
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | accountId | [optional] 
+**aggregation_accounts** | [**Array<BudgetAggregationAccount>**](BudgetAggregationAccount.md) |  | [optional] 
+**budget** | [**Array<BudgetObject>**](BudgetObject.md) |  | [optional] 
+**client_id** | **String** | clientId | 
+**create_date** | **DateTime** |  | [optional] 
+**currency_code** | **String** | currencyCode | 
+**end_date** | **Date** | endDate | [optional] 
+**frequency** | **Integer** | frequency | [optional] 
+**frequency_unit** | **String** | frequencyUnit | 
+**goal_id** | **String** | goalId | [optional] 
+**id** | **String** |  | [optional] 
+**is_active** | **BOOLEAN** | is_active | [optional] 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**name** | **String** | name | 
+**secondary_id** | **String** |  | [optional] 
+**start_date** | **Date** | startDate | [optional] 
+**total_value** | **Float** | totalValue | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/BudgetAggregationAccount.md

@@ -0,0 +1,8 @@
+# NucleusApi::BudgetAggregationAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation_account_id** | **String** | node_id | 
+
+

data/docs/BudgetApi.md

@@ -0,0 +1,315 @@
+# NucleusApi::BudgetApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_budget_using_post**](BudgetApi.md#create_budget_using_post) | **POST** /budget | Create a budget request
+[**delete_budget_using_delete**](BudgetApi.md#delete_budget_using_delete) | **DELETE** /budget/{budget_id} | Delete a budget request
+[**get_budget_all_using_get**](BudgetApi.md#get_budget_all_using_get) | **GET** /budget | List all budget requests
+[**get_budget_using_get**](BudgetApi.md#get_budget_using_get) | **GET** /budget/{budget_id} | Retrieve a budget request
+[**update_budget_using_put**](BudgetApi.md#update_budget_using_put) | **PUT** /budget/{budget_id} | Update a budget request
+
+
+# **create_budget_using_post**
+> Budget create_budget_using_post(budget_request)
+
+Create a budget request
+
+Create a new budget request.
+
+### Example
+```ruby
+# load the gem
+require 'nucleus_api'
+# Setup authorization
+NucleusApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+
+api_instance = NucleusApi::BudgetApi.new
+
+budget_request = NucleusApi::Budget.new # Budget | budgetRequest
+
+
+begin
+  #Create a budget request
+  result = api_instance.create_budget_using_post(budget_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BudgetApi->create_budget_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_request** | [**Budget**](Budget.md)| budgetRequest | 
+
+### Return type
+
+[**Budget**](Budget.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete_budget_using_delete**
+> delete_budget_using_delete(budget_id)
+
+Delete a budget request
+
+Permanently delete a budget request.
+
+### Example
+```ruby
+# load the gem
+require 'nucleus_api'
+# Setup authorization
+NucleusApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+
+api_instance = NucleusApi::BudgetApi.new
+
+budget_id = 'budget_id_example' # String | UUID budget_id
+
+
+begin
+  #Delete a budget request
+  api_instance.delete_budget_using_delete(budget_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BudgetApi->delete_budget_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| UUID budget_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_budget_all_using_get**
+> PageBudget get_budget_all_using_get(opts)
+
+List all budget requests
+
+Get the information for all budget requests.
+
+### Example
+```ruby
+# load the gem
+require 'nucleus_api'
+# Setup authorization
+NucleusApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+
+api_instance = NucleusApi::BudgetApi.new
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  currency_conversion: 'currency_conversion_example', # String | currency_conversion
+  filter: 'filter_example', # String | filter
+  order_by: 'update_date', # String | order_by
+  page: 0, # Integer | page
+  size: 25 # Integer | size
+}
+
+begin
+  #List all budget requests
+  result = api_instance.get_budget_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BudgetApi->get_budget_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
+ **currency_conversion** | **String**| currency_conversion | [optional] 
+ **filter** | **String**| filter | [optional] 
+ **order_by** | **String**| order_by | [optional] [default to update_date]
+ **page** | **Integer**| page | [optional] [default to 0]
+ **size** | **Integer**| size | [optional] [default to 25]
+
+### Return type
+
+[**PageBudget**](PageBudget.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_budget_using_get**
+> Budget get_budget_using_get(budget_id, opts)
+
+Retrieve a budget request
+
+Retrieve the information for a budget request.
+
+### Example
+```ruby
+# load the gem
+require 'nucleus_api'
+# Setup authorization
+NucleusApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+
+api_instance = NucleusApi::BudgetApi.new
+
+budget_id = 'budget_id_example' # String | UUID budget_id
+
+opts = { 
+  currency_conversion: 'currency_conversion_example' # String | USD
+}
+
+begin
+  #Retrieve a budget request
+  result = api_instance.get_budget_using_get(budget_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BudgetApi->get_budget_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| UUID budget_id | 
+ **currency_conversion** | **String**| USD | [optional] 
+
+### Return type
+
+[**Budget**](Budget.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update_budget_using_put**
+> Budget update_budget_using_put(budget, budget_id)
+
+Update a budget request
+
+Update the information for a budget request.
+
+### Example
+```ruby
+# load the gem
+require 'nucleus_api'
+# Setup authorization
+NucleusApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+
+api_instance = NucleusApi::BudgetApi.new
+
+budget = nil # Object | budget
+
+budget_id = 'budget_id_example' # String | UUID budget_id
+
+
+begin
+  #Update a budget request
+  result = api_instance.update_budget_using_put(budget, budget_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BudgetApi->update_budget_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget** | **Object**| budget | 
+ **budget_id** | [**String**](.md)| UUID budget_id | 
+
+### Return type
+
+[**Budget**](Budget.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+

data/docs/BudgetObject.md

@@ -0,0 +1,10 @@
+# NucleusApi::BudgetObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **String** | category | 
+**subcategory** | **String** | subcategory | [optional] 
+**value** | **Float** | value | 
+
+

data/docs/BulkApi.md

@@ -0,0 +1,249 @@
+# NucleusApi::BulkApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_bulk_using_post**](BulkApi.md#create_bulk_using_post) | **POST** /bulk/{entity_uri} | Create a bulk data
+[**delete_bulk_using_delete**](BulkApi.md#delete_bulk_using_delete) | **DELETE** /bulk/{entity_uri} | Delete a bulk data
+[**get_bulk_status_using_get**](BulkApi.md#get_bulk_status_using_get) | **GET** /bulk/status/{id} | Status of bulk transaction
+[**update_bulk_using_put**](BulkApi.md#update_bulk_using_put) | **PUT** /bulk/{entity_uri} | Update a bulk data
+
+
+# **create_bulk_using_post**
+> BulkTransaction create_bulk_using_post(data, entity_uri)
+
+Create a bulk data
+
+Create a new bulk data for your firm.
+
+### Example
+```ruby
+# load the gem
+require 'nucleus_api'
+# Setup authorization
+NucleusApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+
+api_instance = NucleusApi::BulkApi.new
+
+data = NucleusApi::JsonNode.new # JsonNode | data
+
+entity_uri = 'entity_uri_example' # String | UUID entity_uri
+
+
+begin
+  #Create a bulk data
+  result = api_instance.create_bulk_using_post(data, entity_uri)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BulkApi->create_bulk_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**JsonNode**](JsonNode.md)| data | 
+ **entity_uri** | **String**| UUID entity_uri | 
+
+### Return type
+
+[**BulkTransaction**](BulkTransaction.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_bulk_using_delete**
+> BulkTransaction delete_bulk_using_delete(data, entity_uri)
+
+Delete a bulk data
+
+Delete a bulk data for your firm.
+
+### Example
+```ruby
+# load the gem
+require 'nucleus_api'
+# Setup authorization
+NucleusApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+
+api_instance = NucleusApi::BulkApi.new
+
+data = NucleusApi::JsonNode.new # JsonNode | data
+
+entity_uri = 'entity_uri_example' # String | UUID entity_uri
+
+
+begin
+  #Delete a bulk data
+  result = api_instance.delete_bulk_using_delete(data, entity_uri)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BulkApi->delete_bulk_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**JsonNode**](JsonNode.md)| data | 
+ **entity_uri** | **String**| UUID entity_uri | 
+
+### Return type
+
+[**BulkTransaction**](BulkTransaction.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_bulk_status_using_get**
+> BulkTransactionVO get_bulk_status_using_get(id)
+
+Status of bulk transaction
+
+Get the status of bulk transaction.
+
+### Example
+```ruby
+# load the gem
+require 'nucleus_api'
+# Setup authorization
+NucleusApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+
+api_instance = NucleusApi::BulkApi.new
+
+id = 'id_example' # String | UUID Bulk Transaction Id
+
+
+begin
+  #Status of bulk transaction
+  result = api_instance.get_bulk_status_using_get(id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BulkApi->get_bulk_status_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**String**](.md)| UUID Bulk Transaction Id | 
+
+### Return type
+
+[**BulkTransactionVO**](BulkTransactionVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_bulk_using_put**
+> BulkTransaction update_bulk_using_put(data, entity_uri)
+
+Update a bulk data
+
+Update a bulk data for your firm.
+
+### Example
+```ruby
+# load the gem
+require 'nucleus_api'
+# Setup authorization
+NucleusApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+
+api_instance = NucleusApi::BulkApi.new
+
+data = nil # Object | data
+
+entity_uri = 'entity_uri_example' # String | UUID entity_uri
+
+
+begin
+  #Update a bulk data
+  result = api_instance.update_bulk_using_put(data, entity_uri)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BulkApi->update_bulk_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | **Object**| data | 
+ **entity_uri** | **String**| UUID entity_uri | 
+
+### Return type
+
+[**BulkTransaction**](BulkTransaction.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+