nucleus_api 1.8.0

data/docs/AggregationAccountBalance.md

@@ -0,0 +1,18 @@
+# NucleusApi::AggregationAccountBalance
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation_account_id** | **String** | aggregationAccountId | [optional] 
+**available_balance** | **Float** | availableBalance | [optional] 
+**available_credit** | **Float** | availableCredit | [optional] 
+**balance** | **Float** | balance | [optional] 
+**balance_time_stamp** | **DateTime** | balanceTimeStamp | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**currency_code** | **String** | currencyCode | 
+**id** | **String** |  | [optional] 
+**is_active** | **BOOLEAN** | isActive | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/AggregationAccountHolding.md

@@ -0,0 +1,26 @@
+# NucleusApi::AggregationAccountHolding
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation_account_id** | **String** | aggregationAccountId | [optional] 
+**amount** | **Float** |  | [optional] 
+**asset_class** | **String** |  | [optional] 
+**cost_basis** | **Float** |  | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**currency_code** | **String** |  | [optional] 
+**cusip** | **String** |  | [optional] 
+**exchange** | **String** |  | [optional] 
+**holding_date** | **DateTime** | holdingDate | [optional] 
+**holding_type** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**isin** | **String** | isin | [optional] 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**price** | **Float** |  | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**shares** | **Float** |  | 
+**ticker** | **String** |  | 
+**ticker_name** | **String** |  | 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/AggregationAccountTransaction.md

@@ -0,0 +1,23 @@
+# NucleusApi::AggregationAccountTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation_account_id** | **String** | aggregationAccountId | [optional] 
+**bank_credit** | [**BankCredit**](BankCredit.md) |  | [optional] 
+**cash** | [**Cash**](Cash.md) |  | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**currency_code** | **String** | currencyCode | 
+**id** | **String** |  | [optional] 
+**investment** | [**Investment**](Investment.md) |  | [optional] 
+**is_excluded_analysis** | **BOOLEAN** |  | [optional] 
+**is_fee** | **String** |  | [optional] 
+**is_recurring** | **BOOLEAN** |  | [optional] 
+**is_transfer** | **String** |  | [optional] 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**status** | **String** | status | [optional] 
+**transaction_date** | **DateTime** | transactionDate | 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/AggregationAccountsMap.md

@@ -0,0 +1,9 @@
+# NucleusApi::AggregationAccountsMap
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation_account_id** | **String** | aggregationAccountId | 
+**amount** | **Integer** | amount | 
+
+

data/docs/Allocation.md

@@ -0,0 +1,22 @@
+# NucleusApi::Allocation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**benchmark_id** | **String** | benchmarkId | [optional] 
+**category** | **String** |  | [optional] 
+**client_id** | **String** | clientId | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**description** | **String** | description | [optional] 
+**id** | **String** |  | [optional] 
+**inception_date** | **Date** | inceptionDate | [optional] 
+**is_active** | **BOOLEAN** | isActive | [optional] 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**name** | **String** | name | 
+**node_map** | [**Array<AllocationNodeMap>**](AllocationNodeMap.md) |  | [optional] 
+**performance** | **Float** | performance | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+**volatility** | **Float** | volatility | [optional] 
+
+

data/docs/AllocationAggregatedVO.md

@@ -0,0 +1,13 @@
+# NucleusApi::AllocationAggregatedVO
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allocation_category** | **String** |  | [optional] 
+**allocation_compositions** | [**Array<AllocationCompositionAggregatedVO>**](AllocationCompositionAggregatedVO.md) |  | [optional] 
+**allocation_description** | **String** |  | [optional] 
+**allocation_id** | **String** |  | [optional] 
+**allocation_name** | **String** |  | [optional] 
+**allocation_secondary_id** | **String** |  | [optional] 
+
+

data/docs/AllocationApi.md

@@ -0,0 +1,872 @@
+# NucleusApi::AllocationApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_allocation_composition_using_post**](AllocationApi.md#create_allocation_composition_using_post) | **POST** /allocation_composition | Create an allocation composition
+[**create_allocation_using_post**](AllocationApi.md#create_allocation_using_post) | **POST** /allocation | Create an allocation
+[**delete_allocation_composition_using_delete**](AllocationApi.md#delete_allocation_composition_using_delete) | **DELETE** /allocation_composition/{allocation_composition_id} | Delete an allocation composition
+[**delete_allocation_using_delete**](AllocationApi.md#delete_allocation_using_delete) | **DELETE** /allocation/{allocation_id} | Delete an allocation
+[**get_allocation_all_aggregate_data_using_get**](AllocationApi.md#get_allocation_all_aggregate_data_using_get) | **GET** /allocation/{allocation_id}/aggregate_data | List all Allocation aggregated data overview
+[**get_allocation_all_asset_size_all_using_get**](AllocationApi.md#get_allocation_all_asset_size_all_using_get) | **GET** /allocation/{allocation_id}/asset_size | List all allocation asset sizes
+[**get_allocation_all_holding_all_using_get**](AllocationApi.md#get_allocation_all_holding_all_using_get) | **GET** /allocation/{allocation_id}/holding | List all allocation holdings
+[**get_allocation_all_transaction_all_using_get**](AllocationApi.md#get_allocation_all_transaction_all_using_get) | **GET** /allocation/{allocation_id}/transaction | List all allocation transactions
+[**get_allocation_all_using_get**](AllocationApi.md#get_allocation_all_using_get) | **GET** /allocation | List all allocations
+[**get_allocation_composition_all_using_get**](AllocationApi.md#get_allocation_composition_all_using_get) | **GET** /allocation_composition | List all allocations compositions
+[**get_allocation_composition_using_get**](AllocationApi.md#get_allocation_composition_using_get) | **GET** /allocation_composition/{allocation_composition_id} | Retrieve an allocation composition
+[**get_allocation_using_get**](AllocationApi.md#get_allocation_using_get) | **GET** /allocation/{allocation_id} | Retrieve an allocation
+[**update_allocation_composition_using_put**](AllocationApi.md#update_allocation_composition_using_put) | **PUT** /allocation_composition/{allocation_composition_id} | Update an allocation composition
+[**update_allocation_using_put**](AllocationApi.md#update_allocation_using_put) | **PUT** /allocation/{allocation_id} | Update an allocation
+
+
+# **create_allocation_composition_using_post**
+> AllocationComposition create_allocation_composition_using_post(alloc_request)
+
+Create an allocation composition
+
+Create a new allocation composition record for an allocation.
+
+### 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::AllocationApi.new
+
+alloc_request = NucleusApi::AllocationComposition.new # AllocationComposition | allocRequest
+
+
+begin
+  #Create an allocation composition
+  result = api_instance.create_allocation_composition_using_post(alloc_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->create_allocation_composition_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **alloc_request** | [**AllocationComposition**](AllocationComposition.md)| allocRequest | 
+
+### Return type
+
+[**AllocationComposition**](AllocationComposition.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **create_allocation_using_post**
+> Allocation create_allocation_using_post(allocation_request)
+
+Create an allocation
+
+Create a new allocation 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::AllocationApi.new
+
+allocation_request = NucleusApi::Allocation.new # Allocation | allocationRequest
+
+
+begin
+  #Create an allocation
+  result = api_instance.create_allocation_using_post(allocation_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->create_allocation_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_request** | [**Allocation**](Allocation.md)| allocationRequest | 
+
+### Return type
+
+[**Allocation**](Allocation.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete_allocation_composition_using_delete**
+> delete_allocation_composition_using_delete(allocation_composition_id)
+
+Delete an allocation composition
+
+Permanently delete an allocation composition record for an allocation.
+
+### 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::AllocationApi.new
+
+allocation_composition_id = 'allocation_composition_id_example' # String | UUID allocation_composition_id
+
+
+begin
+  #Delete an allocation composition
+  api_instance.delete_allocation_composition_using_delete(allocation_composition_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->delete_allocation_composition_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_composition_id** | [**String**](.md)| UUID allocation_composition_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_allocation_using_delete**
+> delete_allocation_using_delete(allocation_id)
+
+Delete an allocation
+
+Permanently delete an allocation defined by 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::AllocationApi.new
+
+allocation_id = 'allocation_id_example' # String | UUID allocation_id
+
+
+begin
+  #Delete an allocation
+  api_instance.delete_allocation_using_delete(allocation_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->delete_allocation_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_id** | [**String**](.md)| UUID allocation_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_allocation_all_aggregate_data_using_get**
+> AllocationAggregatedVO get_allocation_all_aggregate_data_using_get(allocation_id)
+
+List all Allocation aggregated data overview
+
+### 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::AllocationApi.new
+
+allocation_id = 'allocation_id_example' # String | Allocation Id
+
+
+begin
+  #List all Allocation aggregated data overview
+  result = api_instance.get_allocation_all_aggregate_data_using_get(allocation_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->get_allocation_all_aggregate_data_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_id** | [**String**](.md)| Allocation Id | 
+
+### Return type
+
+[**AllocationAggregatedVO**](AllocationAggregatedVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_allocation_all_asset_size_all_using_get**
+> Array<DateDoubleVO> get_allocation_all_asset_size_all_using_get(allocation_id, opts)
+
+List all allocation asset sizes
+
+Get a list of asset sizes by date for a specific allocation.
+
+### 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::AllocationApi.new
+
+allocation_id = 'allocation_id_example' # String | UUID allocation_id
+
+opts = { 
+  end_date: Date.parse('2013-10-20'), # Date | end date
+  get_latest: true, # BOOLEAN | get_latest
+  is_current_weight: true, # BOOLEAN | is_current_weight
+  sort_type: 'sort_type_example', # String | D (Daily), Q (quarterly), M (Monthly), Y (Annually) 
+  start_date: Date.parse('2013-10-20') # Date | start date
+}
+
+begin
+  #List all allocation asset sizes
+  result = api_instance.get_allocation_all_asset_size_all_using_get(allocation_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->get_allocation_all_asset_size_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_id** | [**String**](.md)| UUID allocation_id | 
+ **end_date** | **Date**| end date | [optional] 
+ **get_latest** | **BOOLEAN**| get_latest | [optional] 
+ **is_current_weight** | **BOOLEAN**| is_current_weight | [optional] [default to true]
+ **sort_type** | **String**| D (Daily), Q (quarterly), M (Monthly), Y (Annually)  | [optional] 
+ **start_date** | **Date**| start date | [optional] 
+
+### Return type
+
+[**Array<DateDoubleVO>**](DateDoubleVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_allocation_all_holding_all_using_get**
+> Array<ModelHoldingVO> get_allocation_all_holding_all_using_get(allocation_id, opts)
+
+List all allocation holdings
+
+Get the information for all securities assigned to a specific allocation. 
+
+### 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::AllocationApi.new
+
+allocation_id = 'allocation_id_example' # String | UUID allocation_id
+
+opts = { 
+  end_date: Date.parse('2013-10-20'), # Date | end date
+  start_date: Date.parse('2013-10-20') # Date | start date
+}
+
+begin
+  #List all allocation holdings
+  result = api_instance.get_allocation_all_holding_all_using_get(allocation_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->get_allocation_all_holding_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_id** | [**String**](.md)| UUID allocation_id | 
+ **end_date** | **Date**| end date | [optional] 
+ **start_date** | **Date**| start date | [optional] 
+
+### Return type
+
+[**Array<ModelHoldingVO>**](ModelHoldingVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_allocation_all_transaction_all_using_get**
+> PageModelTransaction get_allocation_all_transaction_all_using_get(allocation_id, opts)
+
+List all allocation transactions
+
+Get the information for all transactions made under an allocation to achieve the composition of the allocation.
+
+### 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::AllocationApi.new
+
+allocation_id = 'allocation_id_example' # String | UUID allocation_id
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  end_date: Date.parse('2013-10-20'), # Date | end date
+  order_by: 'update_date', # String | order_by
+  page: 0, # Integer | page
+  size: 25, # Integer | size
+  start_date: Date.parse('2013-10-20') # Date | start date
+}
+
+begin
+  #List all allocation transactions
+  result = api_instance.get_allocation_all_transaction_all_using_get(allocation_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->get_allocation_all_transaction_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_id** | [**String**](.md)| UUID allocation_id | 
+ **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
+ **end_date** | **Date**| end date | [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]
+ **start_date** | **Date**| start date | [optional] 
+
+### Return type
+
+[**PageModelTransaction**](PageModelTransaction.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_allocation_all_using_get**
+> PageAllocation get_allocation_all_using_get(opts)
+
+List all allocations
+
+Get details for all allocations defined 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::AllocationApi.new
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  filter: 'filter_example', # String | filter
+  order_by: 'update_date', # String | order_by
+  page: 0, # Integer | page
+  size: 25 # Integer | size
+}
+
+begin
+  #List all allocations
+  result = api_instance.get_allocation_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->get_allocation_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
+ **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
+
+[**PageAllocation**](PageAllocation.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_allocation_composition_all_using_get**
+> PageAllocationComposition get_allocation_composition_all_using_get(opts)
+
+List all allocations compositions
+
+Get the allocation composition for all allocations.
+
+### 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::AllocationApi.new
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  filter: 'filter_example', # String | filter
+  order_by: 'update_date', # String | order_by
+  page: 0, # Integer | page
+  size: 25 # Integer | size
+}
+
+begin
+  #List all allocations compositions
+  result = api_instance.get_allocation_composition_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->get_allocation_composition_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
+ **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
+
+[**PageAllocationComposition**](PageAllocationComposition.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_allocation_composition_using_get**
+> AllocationComposition get_allocation_composition_using_get(allocation_composition_id)
+
+Retrieve an allocation composition
+
+Retrieve the information of an allocation composition record for an allocation.
+
+### 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::AllocationApi.new
+
+allocation_composition_id = 'allocation_composition_id_example' # String | UUID allocation_composition_id
+
+
+begin
+  #Retrieve an allocation composition
+  result = api_instance.get_allocation_composition_using_get(allocation_composition_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->get_allocation_composition_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_composition_id** | [**String**](.md)| UUID allocation_composition_id | 
+
+### Return type
+
+[**AllocationComposition**](AllocationComposition.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_allocation_using_get**
+> Allocation get_allocation_using_get(allocation_id)
+
+Retrieve an allocation
+
+Retrieve the information for an allocation defined by 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::AllocationApi.new
+
+allocation_id = 'allocation_id_example' # String | UUID allocation_id
+
+
+begin
+  #Retrieve an allocation
+  result = api_instance.get_allocation_using_get(allocation_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->get_allocation_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_id** | [**String**](.md)| UUID allocation_id | 
+
+### Return type
+
+[**Allocation**](Allocation.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update_allocation_composition_using_put**
+> AllocationComposition update_allocation_composition_using_put(allocation_composition, allocation_composition_id)
+
+Update an allocation composition
+
+Update the information of an allocation composition record for an allocation.
+
+### 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::AllocationApi.new
+
+allocation_composition = nil # Object | allocation_composition
+
+allocation_composition_id = 'allocation_composition_id_example' # String | UUID allocation_composition_id
+
+
+begin
+  #Update an allocation composition
+  result = api_instance.update_allocation_composition_using_put(allocation_composition, allocation_composition_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->update_allocation_composition_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation_composition** | **Object**| allocation_composition | 
+ **allocation_composition_id** | [**String**](.md)| UUID allocation_composition_id | 
+
+### Return type
+
+[**AllocationComposition**](AllocationComposition.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_allocation_using_put**
+> Allocation update_allocation_using_put(allocation, allocation_id)
+
+Update an allocation
+
+Update an allocation defined by 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::AllocationApi.new
+
+allocation = nil # Object | allocation
+
+allocation_id = 'allocation_id_example' # String | UUID allocation_id
+
+
+begin
+  #Update an allocation
+  result = api_instance.update_allocation_using_put(allocation, allocation_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AllocationApi->update_allocation_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **allocation** | **Object**| allocation | 
+ **allocation_id** | [**String**](.md)| UUID allocation_id | 
+
+### Return type
+
+[**Allocation**](Allocation.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+