nucleus_api 1.8.0

data/docs/AuditLogApi.md

@@ -0,0 +1,191 @@
+# NucleusApi::AuditLogApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_audit_log_using_post**](AuditLogApi.md#create_audit_log_using_post) | **POST** /audit_log | Create a audit log
+[**get_audit_log_all_using_get**](AuditLogApi.md#get_audit_log_all_using_get) | **GET** /audit_log | List all audit log
+[**get_audit_log_using_get**](AuditLogApi.md#get_audit_log_using_get) | **GET** /audit_log/{audit_log_id} | Retrieve a audit log
+
+
+# **create_audit_log_using_post**
+> AuditLog create_audit_log_using_post(audit_log)
+
+Create a audit log
+
+Create a new audit log.
+
+### 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::AuditLogApi.new
+
+audit_log = NucleusApi::AuditLog.new # AuditLog | auditLog
+
+
+begin
+  #Create a audit log
+  result = api_instance.create_audit_log_using_post(audit_log)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AuditLogApi->create_audit_log_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **audit_log** | [**AuditLog**](AuditLog.md)| auditLog | 
+
+### Return type
+
+[**AuditLog**](AuditLog.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **get_audit_log_all_using_get**
+> PageAuditLog get_audit_log_all_using_get(opts)
+
+List all audit log
+
+Get details for all audit log.
+
+### 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::AuditLogApi.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 audit log
+  result = api_instance.get_audit_log_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AuditLogApi->get_audit_log_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
+
+[**PageAuditLog**](PageAuditLog.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_audit_log_using_get**
+> AuditLog get_audit_log_using_get(audit_log_id)
+
+Retrieve a audit log
+
+Retrieve the information for a audit log.
+
+### 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::AuditLogApi.new
+
+audit_log_id = 'audit_log_id_example' # String | UUID audit_log_id
+
+
+begin
+  #Retrieve a audit log
+  result = api_instance.get_audit_log_using_get(audit_log_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling AuditLogApi->get_audit_log_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **audit_log_id** | [**String**](.md)| UUID audit_log_id | 
+
+### Return type
+
+[**AuditLog**](AuditLog.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/AvailableDateDoubleVO.md

@@ -0,0 +1,14 @@
+# NucleusApi::AvailableDateDoubleVO
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**additions** | **Float** | additions | [optional] 
+**cash_flow** | **Float** | cashFlow | [optional] 
+**currency_code** | **String** | currencyCode | [optional] 
+**date** | **String** | date | [optional] 
+**value** | **Float** | value | [optional] 
+**value_available** | **Float** | valueAvailable | [optional] 
+**value_pending** | **Float** | valuePending | [optional] 
+
+

data/docs/BankCredit.md

@@ -0,0 +1,15 @@
+# NucleusApi::BankCredit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | amount | 
+**category** | **String** | category | [optional] 
+**description** | **String** | description | [optional] 
+**location** | [**Location**](Location.md) |  | [optional] 
+**memo** | **String** | memo | [optional] 
+**merchant** | **String** | merchant | [optional] 
+**subcategory** | **String** | subcategory | [optional] 
+**transaction_type** | **String** | transactionType | 
+
+

data/docs/BankLink.md

@@ -0,0 +1,29 @@
+# NucleusApi::BankLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | accountId | [optional] 
+**available_balance** | **Float** | availableBalance | [optional] 
+**balance** | **Float** | balance | [optional] 
+**bank_account_holder** | **String** | bankAccountHolder | 
+**bank_account_name** | **String** | bankAccountName | [optional] 
+**bank_account_number** | **String** | bankAccountNumber | 
+**client_id** | **String** | clientId | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**currency_code** | **String** | currencyCode | [optional] 
+**id** | **String** |  | [optional] 
+**is_active** | **BOOLEAN** | isActive | [optional] 
+**is_default** | **BOOLEAN** | isDefault | [optional] 
+**is_link_verified** | **BOOLEAN** | isLinkVerified | [optional] 
+**link_verified_date** | **Date** | linkVerifiedDate | [optional] 
+**mask** | **String** | mask | [optional] 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**name** | **String** | name | 
+**routing** | **String** | routing | 
+**routing_wire** | **String** | routingWire | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**type** | **String** | type | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/BankLinkMap.md

@@ -0,0 +1,9 @@
+# NucleusApi::BankLinkMap
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bank_link_id** | **String** | bankLinkId | 
+**weight** | **Float** | weight | 
+
+

data/docs/Benchmark.md

@@ -0,0 +1,17 @@
+# NucleusApi::Benchmark
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | clientId | [optional] 
+**composition** | [**Array<BenchmarkComposition>**](BenchmarkComposition.md) | composition | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**description** | **String** | description | [optional] 
+**id** | **String** |  | [optional] 
+**is_active** | **BOOLEAN** | isActive | [optional] 
+**metadata** | **Hash<String, String>** |  | [optional] 
+**name** | **String** | name | 
+**secondary_id** | **String** |  | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/BenchmarkApi.md

@@ -0,0 +1,375 @@
+# NucleusApi::BenchmarkApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_benchmark_using_post**](BenchmarkApi.md#create_benchmark_using_post) | **POST** /benchmark | Create a benchmark
+[**delete_benchmark_using_delete**](BenchmarkApi.md#delete_benchmark_using_delete) | **DELETE** /benchmark/{benchmark_id} | Delete a benchmark
+[**get_benchmark_all_using_get**](BenchmarkApi.md#get_benchmark_all_using_get) | **GET** /benchmark | List all benchmarks
+[**get_benchmark_asset_size_all_using_get**](BenchmarkApi.md#get_benchmark_asset_size_all_using_get) | **GET** /benchmark/{benchmark_id}/asset_size | List all benchmark asset sizes
+[**get_benchmark_using_get**](BenchmarkApi.md#get_benchmark_using_get) | **GET** /benchmark/{benchmark_id} | Retrieve a benchmark
+[**update_benchmark_using_put**](BenchmarkApi.md#update_benchmark_using_put) | **PUT** /benchmark/{benchmark_id} | Update a benchmark
+
+
+# **create_benchmark_using_post**
+> Benchmark create_benchmark_using_post(benchmark)
+
+Create a benchmark
+
+Create a new benchmark 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::BenchmarkApi.new
+
+benchmark = NucleusApi::Benchmark.new # Benchmark | benchmark
+
+
+begin
+  #Create a benchmark
+  result = api_instance.create_benchmark_using_post(benchmark)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BenchmarkApi->create_benchmark_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **benchmark** | [**Benchmark**](Benchmark.md)| benchmark | 
+
+### Return type
+
+[**Benchmark**](Benchmark.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete_benchmark_using_delete**
+> delete_benchmark_using_delete(benchmark_id)
+
+Delete a benchmark
+
+Permanently delete a benchmark.
+
+### 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::BenchmarkApi.new
+
+benchmark_id = 'benchmark_id_example' # String | UUID benchmark_id
+
+
+begin
+  #Delete a benchmark
+  api_instance.delete_benchmark_using_delete(benchmark_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BenchmarkApi->delete_benchmark_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **benchmark_id** | [**String**](.md)| UUID benchmark_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_benchmark_all_using_get**
+> PageBenchmark get_benchmark_all_using_get(opts)
+
+List all benchmarks
+
+Get details for all benchmarks 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::BenchmarkApi.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 benchmarks
+  result = api_instance.get_benchmark_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BenchmarkApi->get_benchmark_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
+
+[**PageBenchmark**](PageBenchmark.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_benchmark_asset_size_all_using_get**
+> Array<DateDoubleVO> get_benchmark_asset_size_all_using_get(benchmark_id, opts)
+
+List all benchmark asset sizes
+
+Get a list of asset sizes by date for a benchmark.
+
+### 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::BenchmarkApi.new
+
+benchmark_id = 'benchmark_id_example' # String | UUID benchmark_id
+
+opts = { 
+  end_date: Date.parse('2013-10-20'), # Date | end date
+  sort_type: 'sort_type_example', # String | sort_type
+  start_date: Date.parse('2013-10-20') # Date | start date
+}
+
+begin
+  #List all benchmark asset sizes
+  result = api_instance.get_benchmark_asset_size_all_using_get(benchmark_id, opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BenchmarkApi->get_benchmark_asset_size_all_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **benchmark_id** | [**String**](.md)| UUID benchmark_id | 
+ **end_date** | **Date**| end date | [optional] 
+ **sort_type** | **String**| sort_type | [optional] 
+ **start_date** | **Date**| start date | [optional] 
+
+### Return type
+
+[**Array<DateDoubleVO>**](DateDoubleVO.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_benchmark_using_get**
+> Benchmark get_benchmark_using_get(benchmark_id)
+
+Retrieve a benchmark
+
+Retrieve the information for a benchmark.
+
+### 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::BenchmarkApi.new
+
+benchmark_id = 'benchmark_id_example' # String | UUID benchmark_id
+
+
+begin
+  #Retrieve a benchmark
+  result = api_instance.get_benchmark_using_get(benchmark_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BenchmarkApi->get_benchmark_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **benchmark_id** | [**String**](.md)| UUID benchmark_id | 
+
+### Return type
+
+[**Benchmark**](Benchmark.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update_benchmark_using_put**
+> Benchmark update_benchmark_using_put(benchmark, benchmark_id)
+
+Update a benchmark
+
+Updated the information for a benchmark.
+
+### 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::BenchmarkApi.new
+
+benchmark = nil # Object | benchmark
+
+benchmark_id = 'benchmark_id_example' # String | UUID benchmark_id
+
+
+begin
+  #Update a benchmark
+  result = api_instance.update_benchmark_using_put(benchmark, benchmark_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling BenchmarkApi->update_benchmark_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **benchmark** | **Object**| benchmark | 
+ **benchmark_id** | [**String**](.md)| UUID benchmark_id | 
+
+### Return type
+
+[**Benchmark**](Benchmark.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+