nucleus_api 1.8.0

data/docs/ClientRelationship.md

@@ -0,0 +1,10 @@
+# NucleusApi::ClientRelationship
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** |  | 
+**member** | [**Member**](Member.md) |  | [optional] 
+**relationship** | **String** |  | 
+
+

data/docs/ClientResponse.md

@@ -0,0 +1,17 @@
+# NucleusApi::ClientResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | account_id | [optional] 
+**answer_id** | **String** | answerId | 
+**answer_value** | **String** | answerValue | 
+**application_id** | **String** | application_id | [optional] 
+**client_id** | **String** | client_id | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**id** | **String** |  | [optional] 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/ClientStatus.md

@@ -0,0 +1,16 @@
+# NucleusApi::ClientStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | clientId | 
+**comments** | **String** | comments | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**id** | **String** |  | [optional] 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**stage_id** | **String** | clientLevelId | 
+**status** | **String** | status | 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/ClientViewGoalData.md

@@ -0,0 +1,21 @@
+# NucleusApi::ClientViewGoalData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accounts** | [**Array<VAccountVO>**](VAccountVO.md) |  | [optional] 
+**accumulation_horizon** | **Float** |  | [optional] 
+**decumulation_horizon** | **Float** |  | [optional] 
+**goal_amount** | **Float** |  | [optional] 
+**goal_asset_size_by_goal** | **Float** |  | [optional] 
+**goal_asset_size_by_goal_date** | **Date** |  | [optional] 
+**goal_category** | **String** |  | [optional] 
+**goal_create_date** | **DateTime** |  | [optional] 
+**goal_id** | **String** |  | [optional] 
+**goal_name** | **String** |  | [optional] 
+**goal_type** | **String** |  | [optional] 
+**goal_update_date** | **DateTime** |  | [optional] 
+**is_decumulation** | **BOOLEAN** |  | [optional] 
+**portfolios** | [**Array<VPortfolioVO>**](VPortfolioVO.md) |  | [optional] 
+
+

data/docs/Country.md

@@ -0,0 +1,12 @@
+# NucleusApi::Country
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**alpha2_code** | **String** | alpha_2_code | 
+**alpha3_code** | **String** | alpha_3_code | [optional] 
+**country** | **String** | country | 
+**latitude** | **Float** | latitude | [optional] 
+**longitude** | **Float** | longitude | [optional] 
+
+

data/docs/Currency.md

@@ -0,0 +1,11 @@
+# NucleusApi::Currency
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**alphabetic_code** | **String** | alphabetic_code | [optional] 
+**currency** | **String** | currency | [optional] 
+**id** | **String** |  | [optional] 
+**numeric_code** | **String** | numeric_code | [optional] 
+
+

data/docs/Customer.md

@@ -0,0 +1,21 @@
+# NucleusApi::Customer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | [**Array<CustomerAddress>**](CustomerAddress.md) |  | [optional] 
+**client_id** | **String** | clientId | [optional] 
+**company_name** | **String** | companyName | 
+**create_date** | **DateTime** |  | [optional] 
+**description** | **String** | description | [optional] 
+**first_name** | **String** | firstName | [optional] 
+**id** | **String** |  | [optional] 
+**identification_number** | **String** | identificationNumber | [optional] 
+**is_active** | **BOOLEAN** | isActive | [optional] 
+**last_name** | **String** | lastName | [optional] 
+**metadata** | **Hash<String, String>** | metadata | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**status** | **String** | status | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/CustomerAddress.md

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

data/docs/CustomerApi.md

@@ -0,0 +1,616 @@
+# NucleusApi::CustomerApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_customer_revenue_using_post**](CustomerApi.md#create_customer_revenue_using_post) | **POST** /customer_revenue | Create a customer revenue
+[**create_customer_using_post**](CustomerApi.md#create_customer_using_post) | **POST** /customer | Create a customer
+[**delete_customer_revenue_using_delete**](CustomerApi.md#delete_customer_revenue_using_delete) | **DELETE** /customer_revenue/{customer_revenue_id} | Delete a customer revenue
+[**delete_customer_using_delete**](CustomerApi.md#delete_customer_using_delete) | **DELETE** /customer/{customer_id} | Delete a customer
+[**get_customer_all_using_get**](CustomerApi.md#get_customer_all_using_get) | **GET** /customer | List all customer
+[**get_customer_revenue_all_using_get**](CustomerApi.md#get_customer_revenue_all_using_get) | **GET** /customer_revenue | List all customer revenue
+[**get_customer_revenue_using_get**](CustomerApi.md#get_customer_revenue_using_get) | **GET** /customer_revenue/{customer_revenue_id} | Retrieve a customer revenue
+[**get_customer_using_get**](CustomerApi.md#get_customer_using_get) | **GET** /customer/{customer_id} | Retrieve a customer
+[**update_customer_revenue_using_put**](CustomerApi.md#update_customer_revenue_using_put) | **PUT** /customer_revenue/{customer_revenue_id} | Update a customer revenue
+[**update_customer_using_put**](CustomerApi.md#update_customer_using_put) | **PUT** /customer/{customer_id} | Update a customer
+
+
+# **create_customer_revenue_using_post**
+> CustomerRevenue create_customer_revenue_using_post(customer_revenue)
+
+Create a customer revenue
+
+Create a new customer revenue, 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::CustomerApi.new
+
+customer_revenue = NucleusApi::CustomerRevenue.new # CustomerRevenue | customerRevenue
+
+
+begin
+  #Create a customer revenue
+  result = api_instance.create_customer_revenue_using_post(customer_revenue)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->create_customer_revenue_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_revenue** | [**CustomerRevenue**](CustomerRevenue.md)| customerRevenue | 
+
+### Return type
+
+[**CustomerRevenue**](CustomerRevenue.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **create_customer_using_post**
+> Customer create_customer_using_post(customer)
+
+Create a customer
+
+Create a new customer, 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::CustomerApi.new
+
+customer = NucleusApi::Customer.new # Customer | customer
+
+
+begin
+  #Create a customer
+  result = api_instance.create_customer_using_post(customer)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->create_customer_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer** | [**Customer**](Customer.md)| customer | 
+
+### Return type
+
+[**Customer**](Customer.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete_customer_revenue_using_delete**
+> delete_customer_revenue_using_delete(customer_revenue_id)
+
+Delete a customer revenue
+
+Delete a customer revenue. 
+
+### 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::CustomerApi.new
+
+customer_revenue_id = 'customer_revenue_id_example' # String | UUID customer_revenue_id
+
+
+begin
+  #Delete a customer revenue
+  api_instance.delete_customer_revenue_using_delete(customer_revenue_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->delete_customer_revenue_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_revenue_id** | [**String**](.md)| UUID customer_revenue_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_customer_using_delete**
+> delete_customer_using_delete(customer_id)
+
+Delete a customer
+
+Delete a customer. 
+
+### 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::CustomerApi.new
+
+customer_id = 'customer_id_example' # String | UUID customer_id
+
+
+begin
+  #Delete a customer
+  api_instance.delete_customer_using_delete(customer_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->delete_customer_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_id** | [**String**](.md)| UUID customer_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_customer_all_using_get**
+> PageCustomer get_customer_all_using_get(opts)
+
+List all customer
+
+List all customer. 
+
+### 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::CustomerApi.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 customer
+  result = api_instance.get_customer_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->get_customer_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
+
+[**PageCustomer**](PageCustomer.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_customer_revenue_all_using_get**
+> PageCustomerRevenue get_customer_revenue_all_using_get(opts)
+
+List all customer revenue
+
+List all customer revenue. 
+
+### 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::CustomerApi.new
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  currency_conversion: 'currency_conversion_example', # String | currency_conversion
+  filter: 'filter_example', # String | filter
+  order_by: 'update_date', # String | order_by
+  page: 0, # Integer | page
+  size: 25 # Integer | size
+}
+
+begin
+  #List all customer revenue
+  result = api_instance.get_customer_revenue_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->get_customer_revenue_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
+ **currency_conversion** | **String**| currency_conversion | [optional] 
+ **filter** | **String**| filter | [optional] 
+ **order_by** | **String**| order_by | [optional] [default to update_date]
+ **page** | **Integer**| page | [optional] [default to 0]
+ **size** | **Integer**| size | [optional] [default to 25]
+
+### Return type
+
+[**PageCustomerRevenue**](PageCustomerRevenue.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_customer_revenue_using_get**
+> CustomerRevenue get_customer_revenue_using_get(customer_revenue_id, opts)
+
+Retrieve a customer revenue
+
+Retrieve a customer revenue. 
+
+### 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::CustomerApi.new
+
+customer_revenue_id = 'customer_revenue_id_example' # String | UUID customer_revenue_id
+
+opts = { 
+  currency_conversion: 'currency_conversion_example' # String | USD
+}
+
+begin
+  #Retrieve a customer revenue
+  result = api_instance.get_customer_revenue_using_get(customer_revenue_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->get_customer_revenue_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_revenue_id** | [**String**](.md)| UUID customer_revenue_id | 
+ **currency_conversion** | **String**| USD | [optional] 
+
+### Return type
+
+[**CustomerRevenue**](CustomerRevenue.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_customer_using_get**
+> Customer get_customer_using_get(customer_id)
+
+Retrieve a customer
+
+Retrieve a customer. 
+
+### 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::CustomerApi.new
+
+customer_id = 'customer_id_example' # String | UUID customer_id
+
+
+begin
+  #Retrieve a customer
+  result = api_instance.get_customer_using_get(customer_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->get_customer_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_id** | [**String**](.md)| UUID customer_id | 
+
+### Return type
+
+[**Customer**](Customer.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update_customer_revenue_using_put**
+> CustomerRevenue update_customer_revenue_using_put(customer_revenue, customer_revenue_id)
+
+Update a customer revenue
+
+Update a customer revenue. 
+
+### 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::CustomerApi.new
+
+customer_revenue = nil # Object | customer_revenue
+
+customer_revenue_id = 'customer_revenue_id_example' # String | UUID customer_revenue_id
+
+
+begin
+  #Update a customer revenue
+  result = api_instance.update_customer_revenue_using_put(customer_revenue, customer_revenue_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->update_customer_revenue_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_revenue** | **Object**| customer_revenue | 
+ **customer_revenue_id** | [**String**](.md)| UUID customer_revenue_id | 
+
+### Return type
+
+[**CustomerRevenue**](CustomerRevenue.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_customer_using_put**
+> Customer update_customer_using_put(customer, customer_id)
+
+Update a customer
+
+Update a customer. 
+
+### 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::CustomerApi.new
+
+customer = nil # Object | customer
+
+customer_id = 'customer_id_example' # String | UUID customer_id
+
+
+begin
+  #Update a customer
+  result = api_instance.update_customer_using_put(customer, customer_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling CustomerApi->update_customer_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer** | **Object**| customer | 
+ **customer_id** | [**String**](.md)| UUID customer_id | 
+
+### Return type
+
+[**Customer**](Customer.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+