nucleus_api 1.8.0

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Account.md

@@ -0,0 +1,22 @@
+# NucleusApi::Account
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | accountNumber | [optional] 
+**account_type_id** | **String** | accountTypeId | 
+**clients** | [**Array<ClientAccountMapping>**](ClientAccountMapping.md) |  | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**currency_code** | **String** | currencyCode | [optional] 
+**discretionary** | **BOOLEAN** | discretionary | [optional] 
+**goals** | [**Array<GoalAccountMapping>**](GoalAccountMapping.md) |  | [optional] 
+**id** | **String** |  | [optional] 
+**is_active** | **BOOLEAN** | isActive | [optional] 
+**managed** | **BOOLEAN** | managed | [optional] 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**name** | **String** | name | 
+**secondary_id** | **String** |  | [optional] 
+**status** | **String** | status | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/AccountAllocationMapping.md

@@ -0,0 +1,17 @@
+# NucleusApi::AccountAllocationMapping
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | accountId | 
+**allocation_id** | **String** | allocationId | 
+**create_date** | **DateTime** |  | [optional] 
+**current_weight** | **Float** | currentWeight | 
+**date** | **Date** | date | 
+**goal_id** | **String** | goalId | [optional] 
+**id** | **String** |  | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**strategic_weight** | **Float** | strategicWeight | 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/AccountApi.md

@@ -0,0 +1,1919 @@
+# NucleusApi::AccountApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_account_allocation_mapping_using_post**](AccountApi.md#create_account_allocation_mapping_using_post) | **POST** /account_allocation | Create an account allocation
+[**create_account_status_using_post**](AccountApi.md#create_account_status_using_post) | **POST** /account_status | Create an account status
+[**create_account_type_using_post**](AccountApi.md#create_account_type_using_post) | **POST** /account_type | Create an account type
+[**create_account_using_post**](AccountApi.md#create_account_using_post) | **POST** /account | Create an account
+[**delete_account_allocation_mapping_using_delete**](AccountApi.md#delete_account_allocation_mapping_using_delete) | **DELETE** /account_allocation/{account_allocation_id} | Delete an account allocation
+[**delete_account_permission_using_delete**](AccountApi.md#delete_account_permission_using_delete) | **DELETE** /account_permission/{account_id} | Delete an account permission
+[**delete_account_status_using_delete**](AccountApi.md#delete_account_status_using_delete) | **DELETE** /account_status/{account_status_id} | Delete an account status
+[**delete_account_type_using_delete**](AccountApi.md#delete_account_type_using_delete) | **DELETE** /account_type/{account_type_id} | Delete an account type
+[**delete_account_using_delete**](AccountApi.md#delete_account_using_delete) | **DELETE** /account/{account_id} | Delete an account
+[**get_account_all_using_get**](AccountApi.md#get_account_all_using_get) | **GET** /account | List all accounts
+[**get_account_allocation_mapping_all_using_get**](AccountApi.md#get_account_allocation_mapping_all_using_get) | **GET** /account_allocation | List all account allocations
+[**get_account_allocation_mapping_using_get**](AccountApi.md#get_account_allocation_mapping_using_get) | **GET** /account_allocation/{account_allocation_id} | Retrieve an account allocation
+[**get_account_asset_size_agg_all_using_get**](AccountApi.md#get_account_asset_size_agg_all_using_get) | **GET** /account/{account_id}/asset_size | List all account asset sizes
+[**get_account_asset_size_all_using_get**](AccountApi.md#get_account_asset_size_all_using_get) | **GET** /account_asset_size | List all account asset sizes
+[**get_account_overview_using_get**](AccountApi.md#get_account_overview_using_get) | **GET** /account/{account_id}/account_overview | List all Account overview
+[**get_account_permission_using_get**](AccountApi.md#get_account_permission_using_get) | **GET** /account_permission/{account_id} | Get an account permission
+[**get_account_status_all_using_get**](AccountApi.md#get_account_status_all_using_get) | **GET** /account_status | List all account statuses
+[**get_account_status_using_get**](AccountApi.md#get_account_status_using_get) | **GET** /account_status/{account_status_id} | Retrieve an account status
+[**get_account_type_all_using_get**](AccountApi.md#get_account_type_all_using_get) | **GET** /account_type | List all account types
+[**get_account_type_using_get**](AccountApi.md#get_account_type_using_get) | **GET** /account_type/{account_type_id} | Get an Account Type
+[**get_account_using_get**](AccountApi.md#get_account_using_get) | **GET** /account/{account_id} | Retrieve an account
+[**get_all_account_permission_using_get**](AccountApi.md#get_all_account_permission_using_get) | **GET** /account_permission | List all account permission
+[**get_portfolio_holding_agg_all_using_get**](AccountApi.md#get_portfolio_holding_agg_all_using_get) | **GET** /account/{account_id}/holding | List all account holdings
+[**get_portfolio_transaction_agg_all_using_get**](AccountApi.md#get_portfolio_transaction_agg_all_using_get) | **GET** /account/{account_id}/transaction | List all account transactions
+[**insert_account_and_related_permission_using_post**](AccountApi.md#insert_account_and_related_permission_using_post) | **POST** /account_permission | create an account permission
+[**subscribe_account_using_post**](AccountApi.md#subscribe_account_using_post) | **POST** /account/{account_id}/subscribe | Subscribe an account
+[**update_account_allocation_mapping_using_put**](AccountApi.md#update_account_allocation_mapping_using_put) | **PUT** /account_allocation/{account_allocation_id} | Update an account allocation
+[**update_account_status_using_put**](AccountApi.md#update_account_status_using_put) | **PUT** /account_status/{account_status_id} | Update an account status
+[**update_account_type_using_put**](AccountApi.md#update_account_type_using_put) | **PUT** /account_type/{account_type_id} | Update an account type
+[**update_account_using_put**](AccountApi.md#update_account_using_put) | **PUT** /account/{account_id} | Update an account
+[**update_client_account_permission_using_put**](AccountApi.md#update_client_account_permission_using_put) | **PUT** /account_permission/{account_id} | Update an account permission
+
+
+# **create_account_allocation_mapping_using_post**
+> AccountAllocationMapping create_account_allocation_mapping_using_post(alloc_request)
+
+Create an account allocation
+
+Create an account-allocation mapping for an account.
+
+### 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::AccountApi.new
+
+alloc_request = NucleusApi::AccountAllocationMapping.new # AccountAllocationMapping | allocRequest
+
+
+begin
+  #Create an account allocation
+  result = api_instance.create_account_allocation_mapping_using_post(alloc_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->create_account_allocation_mapping_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **alloc_request** | [**AccountAllocationMapping**](AccountAllocationMapping.md)| allocRequest | 
+
+### Return type
+
+[**AccountAllocationMapping**](AccountAllocationMapping.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **create_account_status_using_post**
+> AccountStatus create_account_status_using_post(account_status_request)
+
+Create an account status
+
+Create an account status record for an account.
+
+### 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::AccountApi.new
+
+account_status_request = NucleusApi::AccountStatus.new # AccountStatus | accountStatusRequest
+
+
+begin
+  #Create an account status
+  result = api_instance.create_account_status_using_post(account_status_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->create_account_status_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_status_request** | [**AccountStatus**](AccountStatus.md)| accountStatusRequest | 
+
+### Return type
+
+[**AccountStatus**](AccountStatus.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **create_account_type_using_post**
+> AccountType create_account_type_using_post(account_type_request)
+
+Create an account type
+
+Create a new account type 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::AccountApi.new
+
+account_type_request = NucleusApi::AccountType.new # AccountType | accountTypeRequest
+
+
+begin
+  #Create an account type
+  result = api_instance.create_account_type_using_post(account_type_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->create_account_type_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_type_request** | [**AccountType**](AccountType.md)| accountTypeRequest | 
+
+### Return type
+
+[**AccountType**](AccountType.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **create_account_using_post**
+> Account create_account_using_post(client_account_request)
+
+Create an account
+
+Create an account under a client.
+
+### 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::AccountApi.new
+
+client_account_request = NucleusApi::Account.new # Account | clientAccountRequest
+
+
+begin
+  #Create an account
+  result = api_instance.create_account_using_post(client_account_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->create_account_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_account_request** | [**Account**](Account.md)| clientAccountRequest | 
+
+### Return type
+
+[**Account**](Account.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete_account_allocation_mapping_using_delete**
+> delete_account_allocation_mapping_using_delete(account_allocation_id)
+
+Delete an account allocation
+
+Permanently delete an account-allocation mapping for an account.
+
+### 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::AccountApi.new
+
+account_allocation_id = 'account_allocation_id_example' # String | UUID account_allocation_id
+
+
+begin
+  #Delete an account allocation
+  api_instance.delete_account_allocation_mapping_using_delete(account_allocation_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->delete_account_allocation_mapping_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_allocation_id** | [**String**](.md)| UUID account_allocation_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_account_permission_using_delete**
+> AccountPermissionVO delete_account_permission_using_delete(account_id)
+
+Delete an account permission
+
+Delete an account permission
+
+### 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::AccountApi.new
+
+account_id = 'account_id_example' # String | account_id
+
+
+begin
+  #Delete an account permission
+  result = api_instance.delete_account_permission_using_delete(account_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->delete_account_permission_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| account_id | 
+
+### Return type
+
+[**AccountPermissionVO**](AccountPermissionVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_account_status_using_delete**
+> delete_account_status_using_delete(account_status_id)
+
+Delete an account status
+
+Permanently delete an account status record from an account’s history.
+
+### 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::AccountApi.new
+
+account_status_id = 'account_status_id_example' # String | UUID account_status_id
+
+
+begin
+  #Delete an account status
+  api_instance.delete_account_status_using_delete(account_status_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->delete_account_status_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_status_id** | [**String**](.md)| UUID account_status_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_account_type_using_delete**
+> delete_account_type_using_delete(account_type_id)
+
+Delete an account type
+
+Permanently delete a possible account type 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::AccountApi.new
+
+account_type_id = 'account_type_id_example' # String | UUID account_type_id
+
+
+begin
+  #Delete an account type
+  api_instance.delete_account_type_using_delete(account_type_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->delete_account_type_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_type_id** | [**String**](.md)| UUID account_type_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_account_using_delete**
+> delete_account_using_delete(account_id)
+
+Delete an account
+
+Permanently delete an account under a client.
+
+### 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::AccountApi.new
+
+account_id = 'account_id_example' # String | UUID account_id
+
+
+begin
+  #Delete an account
+  api_instance.delete_account_using_delete(account_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->delete_account_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| UUID account_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_all_using_get**
+> PageAccount get_account_all_using_get(opts)
+
+List all accounts
+
+Get information for all accounts for all clients 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::AccountApi.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 accounts
+  result = api_instance.get_account_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_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
+
+[**PageAccount**](PageAccount.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_allocation_mapping_all_using_get**
+> PageAccountAllocationMapping get_account_allocation_mapping_all_using_get(opts)
+
+List all account allocations
+
+Get information for all account-allocation mappings for all accounts 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::AccountApi.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 account allocations
+  result = api_instance.get_account_allocation_mapping_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_allocation_mapping_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
+
+[**PageAccountAllocationMapping**](PageAccountAllocationMapping.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_allocation_mapping_using_get**
+> AccountAllocationMapping get_account_allocation_mapping_using_get(account_allocation_id)
+
+Retrieve an account allocation
+
+Retrieve the information for a specific account-allocation mapping for an account.
+
+### 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::AccountApi.new
+
+account_allocation_id = 'account_allocation_id_example' # String | UUID account_allocation_id
+
+
+begin
+  #Retrieve an account allocation
+  result = api_instance.get_account_allocation_mapping_using_get(account_allocation_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_allocation_mapping_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_allocation_id** | [**String**](.md)| UUID account_allocation_id | 
+
+### Return type
+
+[**AccountAllocationMapping**](AccountAllocationMapping.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_asset_size_agg_all_using_get**
+> Array<AvailableDateDoubleVO> get_account_asset_size_agg_all_using_get(account_id, opts)
+
+List all account asset sizes
+
+Get a list of asset sizes by date for an account.
+
+### 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::AccountApi.new
+
+account_id = 'account_id_example' # String | Account Id
+
+opts = { 
+  currency_conversion: 'currency_conversion_example', # String | USD
+  end_date: Date.parse('2013-10-20'), # Date | end date
+  exclude_subledger: true, # BOOLEAN | true or false
+  get_latest: true, # BOOLEAN | true or false
+  sort_type: 'sort_type_example', # String |  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in ()
+  start_date: Date.parse('2013-10-20') # Date | start date
+}
+
+begin
+  #List all account asset sizes
+  result = api_instance.get_account_asset_size_agg_all_using_get(account_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_asset_size_agg_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| Account Id | 
+ **currency_conversion** | **String**| USD | [optional] 
+ **end_date** | **Date**| end date | [optional] 
+ **exclude_subledger** | **BOOLEAN**| true or false | [optional] 
+ **get_latest** | **BOOLEAN**| true or false | [optional] 
+ **sort_type** | **String**|  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () | [optional] 
+ **start_date** | **Date**| start date | [optional] 
+
+### Return type
+
+[**Array<AvailableDateDoubleVO>**](AvailableDateDoubleVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_asset_size_all_using_get**
+> PageVAccountAssetSize get_account_asset_size_all_using_get(opts)
+
+List all account asset sizes
+
+Get information for all account asset sizes
+
+### 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::AccountApi.new
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  filter: 'filter_example', # String | filter
+  order_by: 'date', # String | order_by
+  page: 0, # Integer | page
+  size: 25 # Integer | size
+}
+
+begin
+  #List all account asset sizes
+  result = api_instance.get_account_asset_size_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_asset_size_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 date]
+ **page** | **Integer**| page | [optional] [default to 0]
+ **size** | **Integer**| size | [optional] [default to 25]
+
+### Return type
+
+[**PageVAccountAssetSize**](PageVAccountAssetSize.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_overview_using_get**
+> Object get_account_overview_using_get(account_id, opts)
+
+List all Account 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::AccountApi.new
+
+account_id = 'account_id_example' # String | UUID account_id
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  order_by: 'update_date' # String | order_by
+}
+
+begin
+  #List all Account overview
+  result = api_instance.get_account_overview_using_get(account_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_overview_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| UUID account_id | 
+ **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
+ **order_by** | **String**| order_by | [optional] [default to update_date]
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_permission_using_get**
+> AccountPermissionVO get_account_permission_using_get(account_id)
+
+Get an account permission
+
+Get an account permission
+
+### 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::AccountApi.new
+
+account_id = 'account_id_example' # String | account_id
+
+
+begin
+  #Get an account permission
+  result = api_instance.get_account_permission_using_get(account_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_permission_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| account_id | 
+
+### Return type
+
+[**AccountPermissionVO**](AccountPermissionVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_status_all_using_get**
+> PageAccountStatus get_account_status_all_using_get(opts)
+
+List all account statuses
+
+Get the account status history information for all accounts.
+
+### 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::AccountApi.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 account statuses
+  result = api_instance.get_account_status_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_status_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
+
+[**PageAccountStatus**](PageAccountStatus.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_status_using_get**
+> AccountStatus get_account_status_using_get(account_status_id)
+
+Retrieve an account status
+
+Retrieve the information for a specific account status record for an account.
+
+### 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::AccountApi.new
+
+account_status_id = 'account_status_id_example' # String | UUID account_status_id
+
+
+begin
+  #Retrieve an account status
+  result = api_instance.get_account_status_using_get(account_status_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_status_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_status_id** | [**String**](.md)| UUID account_status_id | 
+
+### Return type
+
+[**AccountStatus**](AccountStatus.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_type_all_using_get**
+> PageAccountType get_account_type_all_using_get(opts)
+
+List all account types
+
+List all account types 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::AccountApi.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 account types
+  result = api_instance.get_account_type_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_type_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
+
+[**PageAccountType**](PageAccountType.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_type_using_get**
+> AccountType get_account_type_using_get(account_type_id)
+
+Get an Account Type
+
+Get an account types 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::AccountApi.new
+
+account_type_id = 'account_type_id_example' # String | UUID account_type_id
+
+
+begin
+  #Get an Account Type
+  result = api_instance.get_account_type_using_get(account_type_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_type_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_type_id** | [**String**](.md)| UUID account_type_id | 
+
+### Return type
+
+[**AccountType**](AccountType.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_account_using_get**
+> Account get_account_using_get(account_id)
+
+Retrieve an account
+
+Retrieve the information for a specific account associated with a client.
+
+### 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::AccountApi.new
+
+account_id = 'account_id_example' # String | UUID account_id
+
+
+begin
+  #Retrieve an account
+  result = api_instance.get_account_using_get(account_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_account_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| UUID account_id | 
+
+### Return type
+
+[**Account**](Account.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_all_account_permission_using_get**
+> PageAccountPermissionVO get_all_account_permission_using_get(opts)
+
+List all account permission
+
+List all account permission
+
+### 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::AccountApi.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 account permission
+  result = api_instance.get_all_account_permission_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_all_account_permission_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
+
+[**PageAccountPermissionVO**](PageAccountPermissionVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_portfolio_holding_agg_all_using_get**
+> Array<PortfolioHoldingAgg> get_portfolio_holding_agg_all_using_get(account_id, opts)
+
+List all account holdings
+
+Get information for all the securities that are currently being held by an account.
+
+### 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::AccountApi.new
+
+account_id = 'account_id_example' # String | UUID account_id
+
+opts = { 
+  currency_conversion: 'currency_conversion_example', # String | USD
+  end_date: Date.parse('2013-10-20'), # Date | end date 
+  get_latest: true, # BOOLEAN | true or false
+  start_date: Date.parse('2013-10-20') # Date | start date 
+}
+
+begin
+  #List all account holdings
+  result = api_instance.get_portfolio_holding_agg_all_using_get(account_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_portfolio_holding_agg_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| UUID account_id | 
+ **currency_conversion** | **String**| USD | [optional] 
+ **end_date** | **Date**| end date  | [optional] 
+ **get_latest** | **BOOLEAN**| true or false | [optional] 
+ **start_date** | **Date**| start date  | [optional] 
+
+### Return type
+
+[**Array<PortfolioHoldingAgg>**](PortfolioHoldingAgg.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_portfolio_transaction_agg_all_using_get**
+> PagePortfolioTransaction get_portfolio_transaction_agg_all_using_get(account_id, opts)
+
+List all account transactions
+
+Get the information for all transactions for an account.
+
+### 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::AccountApi.new
+
+account_id = 'account_id_example' # String | UUID account_id
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  currency_conversion: 'currency_conversion_example', # String | USD
+  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 account transactions
+  result = api_instance.get_portfolio_transaction_agg_all_using_get(account_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->get_portfolio_transaction_agg_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| UUID account_id | 
+ **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
+ **currency_conversion** | **String**| USD | [optional] 
+ **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
+
+[**PagePortfolioTransaction**](PagePortfolioTransaction.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **insert_account_and_related_permission_using_post**
+> AccountPermissionVO insert_account_and_related_permission_using_post(acl_client_permission_vo)
+
+create an account permission
+
+create an account permission
+
+### 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::AccountApi.new
+
+acl_client_permission_vo = NucleusApi::AclClientPermissionVO.new # AclClientPermissionVO | aclClientPermissionVO
+
+
+begin
+  #create an account permission
+  result = api_instance.insert_account_and_related_permission_using_post(acl_client_permission_vo)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->insert_account_and_related_permission_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **acl_client_permission_vo** | [**AclClientPermissionVO**](AclClientPermissionVO.md)| aclClientPermissionVO | 
+
+### Return type
+
+[**AccountPermissionVO**](AccountPermissionVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **subscribe_account_using_post**
+> Array<Portfolio> subscribe_account_using_post(account_id, alloc_request)
+
+Subscribe an account
+
+After creating an account, you may create portfolios for the account to track a client’s investment, savings, or insurance products.
+
+### 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::AccountApi.new
+
+account_id = 'account_id_example' # String | UUID account_id
+
+alloc_request = NucleusApi::AccountAllocationMapping.new # AccountAllocationMapping | allocRequest
+
+
+begin
+  #Subscribe an account
+  result = api_instance.subscribe_account_using_post(account_id, alloc_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->subscribe_account_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| UUID account_id | 
+ **alloc_request** | [**AccountAllocationMapping**](AccountAllocationMapping.md)| allocRequest | 
+
+### Return type
+
+[**Array<Portfolio>**](Portfolio.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_account_allocation_mapping_using_put**
+> AccountAllocationMapping update_account_allocation_mapping_using_put(account_allocation_id, opts)
+
+Update an account allocation
+
+Update the information for an account-allocation mapping.
+
+### 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::AccountApi.new
+
+account_allocation_id = 'account_allocation_id_example' # String | UUID account_allocation_id
+
+opts = { 
+  account_allocation_mapping: nil # Object | account_allocation_mapping
+}
+
+begin
+  #Update an account allocation
+  result = api_instance.update_account_allocation_mapping_using_put(account_allocation_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->update_account_allocation_mapping_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_allocation_id** | [**String**](.md)| UUID account_allocation_id | 
+ **account_allocation_mapping** | **Object**| account_allocation_mapping | [optional] 
+
+### Return type
+
+[**AccountAllocationMapping**](AccountAllocationMapping.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_account_status_using_put**
+> AccountStatus update_account_status_using_put(account_status, account_status_id)
+
+Update an account status
+
+Update an account status record for an account.
+
+### 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::AccountApi.new
+
+account_status = nil # Object | account_status
+
+account_status_id = 'account_status_id_example' # String | UUID account_status_id
+
+
+begin
+  #Update an account status
+  result = api_instance.update_account_status_using_put(account_status, account_status_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->update_account_status_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_status** | **Object**| account_status | 
+ **account_status_id** | [**String**](.md)| UUID account_status_id | 
+
+### Return type
+
+[**AccountStatus**](AccountStatus.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_account_type_using_put**
+> AccountType update_account_type_using_put(account_type, account_type_id)
+
+Update an account type
+
+Update the information for a possible account type 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::AccountApi.new
+
+account_type = nil # Object | account_type
+
+account_type_id = 'account_type_id_example' # String | UUID account_type_id
+
+
+begin
+  #Update an account type
+  result = api_instance.update_account_type_using_put(account_type, account_type_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->update_account_type_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_type** | **Object**| account_type | 
+ **account_type_id** | [**String**](.md)| UUID account_type_id | 
+
+### Return type
+
+[**AccountType**](AccountType.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_account_using_put**
+> Account update_account_using_put(account, account_id)
+
+Update an account
+
+Update the information for an account.
+
+### 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::AccountApi.new
+
+account = nil # Object | account
+
+account_id = 'account_id_example' # String | UUID account_id
+
+
+begin
+  #Update an account
+  result = api_instance.update_account_using_put(account, account_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->update_account_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account** | **Object**| account | 
+ **account_id** | [**String**](.md)| UUID account_id | 
+
+### Return type
+
+[**Account**](Account.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_client_account_permission_using_put**
+> AccountPermissionVO update_client_account_permission_using_put(account_id, acl_client_permission_vo)
+
+Update an account permission
+
+Update an account permission
+
+### 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::AccountApi.new
+
+account_id = 'account_id_example' # String | account_id
+
+acl_client_permission_vo = nil # Object | aclClientPermissionVO
+
+
+begin
+  #Update an account permission
+  result = api_instance.update_client_account_permission_using_put(account_id, acl_client_permission_vo)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AccountApi->update_client_account_permission_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | [**String**](.md)| account_id | 
+ **acl_client_permission_vo** | **Object**| aclClientPermissionVO | 
+
+### Return type
+
+[**AccountPermissionVO**](AccountPermissionVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+