nucleus_api 1.8.0

data/docs/CardProgram.md

@@ -0,0 +1,23 @@
+# NucleusApi::CardProgram
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card_network** | **String** | cardNetwork | 
+**card_processor** | **String** | cardProcessor | [optional] 
+**card_type** | **String** | cardType | 
+**client_id** | **String** | clientId | [optional] 
+**code** | **String** | code | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**description** | **String** | description | [optional] 
+**id** | **String** |  | [optional] 
+**is_active** | **BOOLEAN** | is_active | [optional] 
+**is_delegated_authority** | **BOOLEAN** | is_delegated_authority | [optional] 
+**issuing_bank** | **String** | issuingBank | 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**name** | **String** | name | 
+**program_manager** | **String** | programManager | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/Cash.md

@@ -0,0 +1,10 @@
+# NucleusApi::Cash
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | cashAmount | 
+**name** | **String** | cashName | [optional] 
+**transaction_type** | **String** | cashTransactionType | 
+
+

data/docs/CategoriesMap.md

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

data/docs/CategoryInternalResponseVO.md

@@ -0,0 +1,10 @@
+# NucleusApi::CategoryInternalResponseVO
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **String** |  | [optional] 
+**subcategories** | **Array<String>** |  | [optional] 
+**tenant_name** | **String** |  | [optional] 
+
+

data/docs/CategoryResponseVO.md

@@ -0,0 +1,9 @@
+# NucleusApi::CategoryResponseVO
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**categories** | [**Array<CategoryInternalResponseVO>**](CategoryInternalResponseVO.md) |  | [optional] 
+**vendor_name** | **String** |  | [optional] 
+
+

data/docs/Check.md

@@ -0,0 +1,10 @@
+# NucleusApi::Check
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**check_amount** | **Float** | checkAmount | [optional] 
+**check_images** | [**Array<CheckImages>**](CheckImages.md) | checkImages | [optional] 
+**check_number** | **String** | checkNumber | 
+
+

data/docs/CheckImages.md

@@ -0,0 +1,9 @@
+# NucleusApi::CheckImages
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_type** | **String** | imageType | [optional] 
+**image_url** | **String** | imageUrl | 
+
+

data/docs/Client.md

@@ -0,0 +1,39 @@
+# NucleusApi::Client
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | [**Array<ClientAddress>**](ClientAddress.md) |  | [optional] 
+**business_id** | **String** | business_id | [optional] 
+**citizenship_status** | **String** | citizenshipStatus | [optional] 
+**client_type** | **String** | clientTypeId | 
+**country_of_citizenship** | **Array<String>** | countryOfCitizenship | [optional] 
+**country_of_residence** | **String** | countryOfResidence | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**date_of_birth** | **String** | dateOfBirth | [optional] 
+**email** | **String** | email | [optional] 
+**employment** | [**Employment**](Employment.md) |  | [optional] 
+**firm_name** | **String** | firmName | [optional] 
+**firm_type** | **String** | firmType | [optional] 
+**first_name** | **String** | firstName | [optional] 
+**gender** | **String** | gender | [optional] 
+**hydro_id** | **String** | hydroId | [optional] 
+**id** | **String** |  | [optional] 
+**identification_number** | **String** | identificationNumber | [optional] 
+**identification_number_type** | **String** | identificationNumberType | [optional] 
+**image** | **String** | image | [optional] 
+**income** | **Integer** | income | [optional] 
+**is_active** | **BOOLEAN** | isActive | [optional] 
+**is_verified** | **BOOLEAN** | isVerified | [optional] 
+**last_name** | **String** | last_name | [optional] 
+**liquid_net_worth** | **Float** | liquidNetWorth | [optional] 
+**metadata** | **Hash<String, String>** | metadata | [optional] 
+**middle_name** | **String** | middleName | [optional] 
+**phone_number** | **String** | phoneNumber | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**status** | **String** | status | [optional] 
+**suffix** | **String** | suffix | [optional] 
+**title** | **String** | title | [optional] 
+**total_net_worth** | **Float** | totalNetWorth | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+**username** | **String** | username | 

data/docs/ClientAccountMapping.md

@@ -0,0 +1,10 @@
+# NucleusApi::ClientAccountMapping
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_account_association_type** | **String** | clientAccountAssociationType | 
+**client_id** | **String** | clientId | 
+**signature_data** | **String** |  | [optional] 
+
+

data/docs/ClientAddress.md

@@ -0,0 +1,15 @@
+# NucleusApi::ClientAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_line1** | **String** | addressLine1 | 
+**address_line2** | **String** | addressLine2 | [optional] 
+**city** | **String** | city | 
+**country** | **String** | country | 
+**is_primary** | **BOOLEAN** |  is_primary | [optional] 
+**postalcode** | **String** | postalcode | [optional] 
+**state** | **String** | state | 
+**type** | **String** | type | 
+
+

data/docs/ClientApi.md

@@ -0,0 +1,1008 @@
+# NucleusApi::ClientApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_client_status_using_post**](ClientApi.md#create_client_status_using_post) | **POST** /client_status | Create an client status
+[**create_client_using_post**](ClientApi.md#create_client_using_post) | **POST** /client | Create a client
+[**delete_client_status_using_delete**](ClientApi.md#delete_client_status_using_delete) | **DELETE** /client_status/{client_status_id} | Delete an client status
+[**delete_client_using_delete**](ClientApi.md#delete_client_using_delete) | **DELETE** /client/{client_id} | Delete a client
+[**get_client_account_overview_using_get**](ClientApi.md#get_client_account_overview_using_get) | **GET** /client/{client_id}/account_overview | List all client Account overview
+[**get_client_advisor_overview_using_get**](ClientApi.md#get_client_advisor_overview_using_get) | **GET** /client/{client_id}/advisor_overview | Advisor overview
+[**get_client_all_using_get**](ClientApi.md#get_client_all_using_get) | **GET** /client | List all clients
+[**get_client_asset_size_using_get**](ClientApi.md#get_client_asset_size_using_get) | **GET** /client/{client_id}/asset_size | List all client asset sizes
+[**get_client_goal_overview_using_get**](ClientApi.md#get_client_goal_overview_using_get) | **GET** /client/{client_id}/goal_overview | Retrieve client's goal details 
+[**get_client_holding_using_get**](ClientApi.md#get_client_holding_using_get) | **GET** /client/{client_id}/holding | List all client holdings
+[**get_client_status_all_using_get**](ClientApi.md#get_client_status_all_using_get) | **GET** /client_status | List all client statuses
+[**get_client_status_using_get**](ClientApi.md#get_client_status_using_get) | **GET** /client_status/{client_status_id} | Retrieve an client status
+[**get_client_transaction_all_using_get**](ClientApi.md#get_client_transaction_all_using_get) | **GET** /client/{client_id}/transaction | List all client transactions
+[**get_client_using_get**](ClientApi.md#get_client_using_get) | **GET** /client/{client_id} | Retrieve a client
+[**update_client_status_using_put**](ClientApi.md#update_client_status_using_put) | **PUT** /client_status/{client_status_id} | Update an client status
+[**update_client_using_put**](ClientApi.md#update_client_using_put) | **PUT** /client/{client_id} | Update a client
+
+
+# **create_client_status_using_post**
+> ClientStatus create_client_status_using_post(client_status_request)
+
+Create an client status
+
+Create an client status record for an 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::ClientApi.new
+
+client_status_request = NucleusApi::ClientStatus.new # ClientStatus | clientStatusRequest
+
+
+begin
+  #Create an client status
+  result = api_instance.create_client_status_using_post(client_status_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->create_client_status_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_status_request** | [**ClientStatus**](ClientStatus.md)| clientStatusRequest | 
+
+### Return type
+
+[**ClientStatus**](ClientStatus.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **create_client_using_post**
+> Client create_client_using_post(client_request)
+
+Create a client
+
+Create a new client, or register a new user, with 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::ClientApi.new
+
+client_request = NucleusApi::Client.new # Client | clientRequest
+
+
+begin
+  #Create a client
+  result = api_instance.create_client_using_post(client_request)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->create_client_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_request** | [**Client**](Client.md)| clientRequest | 
+
+### Return type
+
+[**Client**](Client.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete_client_status_using_delete**
+> delete_client_status_using_delete(client_status_id)
+
+Delete an client status
+
+Permanently delete an client status record from an client’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::ClientApi.new
+
+client_status_id = 'client_status_id_example' # String | UUID client_status_id
+
+
+begin
+  #Delete an client status
+  api_instance.delete_client_status_using_delete(client_status_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->delete_client_status_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_status_id** | [**String**](.md)| UUID client_status_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_client_using_delete**
+> delete_client_using_delete(client_id)
+
+Delete a client
+
+Permanently delete a client registered with your firm. Turns the client's is_active  = 0
+
+### 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::ClientApi.new
+
+client_id = 'client_id_example' # String | UUID client_id
+
+
+begin
+  #Delete a client
+  api_instance.delete_client_using_delete(client_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->delete_client_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | [**String**](.md)| UUID client_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_account_overview_using_get**
+> Object get_client_account_overview_using_get(client_id, opts)
+
+List all client 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::ClientApi.new
+
+client_id = 'client_id_example' # String | UUID client_id
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  order_by: 'update_date' # String | order_by
+}
+
+begin
+  #List all client Account overview
+  result = api_instance.get_client_account_overview_using_get(client_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_account_overview_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | [**String**](.md)| UUID client_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_client_advisor_overview_using_get**
+> Object get_client_advisor_overview_using_get(client_id, opts)
+
+Advisor 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::ClientApi.new
+
+client_id = 'client_id_example' # String | UUID client_id
+
+opts = { 
+  show_clients: false # BOOLEAN | show_clients
+}
+
+begin
+  #Advisor overview
+  result = api_instance.get_client_advisor_overview_using_get(client_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_advisor_overview_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | [**String**](.md)| UUID client_id | 
+ **show_clients** | **BOOLEAN**| show_clients | [optional] [default to false]
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_all_using_get**
+> PageClient get_client_all_using_get(opts)
+
+List all clients
+
+Get details for all clients registered with 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::ClientApi.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 clients
+  result = api_instance.get_client_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_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
+
+[**PageClient**](PageClient.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_asset_size_using_get**
+> Array<AvailableDateDoubleVO> get_client_asset_size_using_get(client_id, opts)
+
+List all client asset sizes
+
+Get a list of asset sizes per date for 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::ClientApi.new
+
+client_id = 'client_id_example' # String | UUID client_id
+
+opts = { 
+  currency_conversion: 'currency_conversion_example', # String | Currency Code
+  end_date: Date.parse('null'), # Date | end date
+  exclude_subledger: false, # BOOLEAN | exclude_subledger
+  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('null') # Date | start date
+}
+
+begin
+  #List all client asset sizes
+  result = api_instance.get_client_asset_size_using_get(client_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_asset_size_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | [**String**](.md)| UUID client_id | 
+ **currency_conversion** | **String**| Currency Code | [optional] 
+ **end_date** | **Date**| end date | [optional] [default to null]
+ **exclude_subledger** | **BOOLEAN**| exclude_subledger | [optional] [default to false]
+ **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] [default to null]
+
+### Return type
+
+[**Array<AvailableDateDoubleVO>**](AvailableDateDoubleVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_goal_overview_using_get**
+> VClientGoalViewData get_client_goal_overview_using_get(client_id, opts)
+
+Retrieve client's goal details 
+
+Retrieve client's goal details
+
+### 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::ClientApi.new
+
+client_id = 'client_id_example' # String | UUID client_id
+
+opts = { 
+  portfolio_goal: false # BOOLEAN | portfolio_goal
+}
+
+begin
+  #Retrieve client's goal details 
+  result = api_instance.get_client_goal_overview_using_get(client_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_goal_overview_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | [**String**](.md)| UUID client_id | 
+ **portfolio_goal** | **BOOLEAN**| portfolio_goal | [optional] [default to false]
+
+### Return type
+
+[**VClientGoalViewData**](VClientGoalViewData.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_holding_using_get**
+> Array<PortfolioHoldingAgg> get_client_holding_using_get(client_id, opts)
+
+List all client holdings
+
+Get the information for all the securities that are currently being held by a client registered with 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::ClientApi.new
+
+client_id = 'client_id_example' # String | UUID client_id
+
+opts = { 
+  currency_conversion: 'currency_conversion_example', # String | Currency Code
+  end_date: 'end_date_example', # String | end date - yyyy-mm-dd
+  get_latest: true, # BOOLEAN | true or false
+  start_date: 'start_date_example' # String | start date - yyyy-mm-dd
+}
+
+begin
+  #List all client holdings
+  result = api_instance.get_client_holding_using_get(client_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_holding_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | [**String**](.md)| UUID client_id | 
+ **currency_conversion** | **String**| Currency Code | [optional] 
+ **end_date** | **String**| end date - yyyy-mm-dd | [optional] 
+ **get_latest** | **BOOLEAN**| true or false | [optional] 
+ **start_date** | **String**| start date - yyyy-mm-dd | [optional] 
+
+### Return type
+
+[**Array<PortfolioHoldingAgg>**](PortfolioHoldingAgg.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_status_all_using_get**
+> PageClientStatus get_client_status_all_using_get(opts)
+
+List all client statuses
+
+Get the client status history information for all clients.
+
+### 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::ClientApi.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 client statuses
+  result = api_instance.get_client_status_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_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
+
+[**PageClientStatus**](PageClientStatus.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_status_using_get**
+> ClientStatus get_client_status_using_get(client_status_id)
+
+Retrieve an client status
+
+Retrieve the information for a specific client status record for an 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::ClientApi.new
+
+client_status_id = 'client_status_id_example' # String | UUID client_status_id
+
+
+begin
+  #Retrieve an client status
+  result = api_instance.get_client_status_using_get(client_status_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_status_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_status_id** | [**String**](.md)| UUID client_status_id | 
+
+### Return type
+
+[**ClientStatus**](ClientStatus.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_transaction_all_using_get**
+> PagePortfolioTransaction get_client_transaction_all_using_get(client_id, opts)
+
+List all client transactions
+
+Get the information for all transactions under a client registered with 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::ClientApi.new
+
+client_id = 'client_id_example' # String | UUID client_id
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  currency_conversion: 'currency_conversion_example', # String | currency_conversion
+  end_date: 'end_date_example', # String | end date - yyyy-mm-dd
+  order_by: 'update_date', # String | order_by
+  page: 0, # Integer | page
+  size: 25, # Integer | size
+  start_date: 'start_date_example' # String | start date - yyyy-mm-dd
+}
+
+begin
+  #List all client transactions
+  result = api_instance.get_client_transaction_all_using_get(client_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_transaction_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | [**String**](.md)| UUID client_id | 
+ **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
+ **currency_conversion** | **String**| currency_conversion | [optional] 
+ **end_date** | **String**| end date - yyyy-mm-dd | [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** | **String**| start date - yyyy-mm-dd | [optional] 
+
+### Return type
+
+[**PagePortfolioTransaction**](PagePortfolioTransaction.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_using_get**
+> Client get_client_using_get(client_id)
+
+Retrieve a client
+
+Retrieve the information for a client registered with 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::ClientApi.new
+
+client_id = 'client_id_example' # String | UUID client_id
+
+
+begin
+  #Retrieve a client
+  result = api_instance.get_client_using_get(client_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->get_client_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | [**String**](.md)| UUID client_id | 
+
+### Return type
+
+[**Client**](Client.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update_client_status_using_put**
+> ClientStatus update_client_status_using_put(client_status, client_status_id)
+
+Update an client status
+
+Update an client status record for an 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::ClientApi.new
+
+client_status = nil # Object | client_status
+
+client_status_id = 'client_status_id_example' # String | UUID client_status_id
+
+
+begin
+  #Update an client status
+  result = api_instance.update_client_status_using_put(client_status, client_status_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->update_client_status_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_status** | **Object**| client_status | 
+ **client_status_id** | [**String**](.md)| UUID client_status_id | 
+
+### Return type
+
+[**ClientStatus**](ClientStatus.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_client_using_put**
+> Client update_client_using_put(client, client_id)
+
+Update a client
+
+Update the information for a client registered with 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::ClientApi.new
+
+client = nil # Object | client
+
+client_id = 'client_id_example' # String | UUID client_id
+
+
+begin
+  #Update a client
+  result = api_instance.update_client_using_put(client, client_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling ClientApi->update_client_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **Object**| client | 
+ **client_id** | [**String**](.md)| UUID client_id | 
+
+### Return type
+
+[**Client**](Client.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+