proton_api 1.8.0

data/docs/AnnuityCalculatorAccumulationHorizonRequest.md

@@ -0,0 +1,19 @@
+# ProtonApi::AnnuityCalculatorAccumulationHorizonRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annuity_amount** | **Float** |  | 
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**tax_rate** | **Float** |  | [optional] [default to 0.0]
+**account_ids** | **Array<String>** |  | [optional] 
+**initial_balance** | **Float** |  | [optional] [default to 0.0]
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**decumulation_horizon** | **Integer** |  | 
+**accumulation_horizon** | **Integer** |  | [optional] 
+**annuity_frequency_interval** | **String** |  | [optional] [default to 'year']
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) |  | [optional] 
+
+

data/docs/AnnuityCalculatorAnnuityAmountRequest.md

@@ -0,0 +1,19 @@
+# ProtonApi::AnnuityCalculatorAnnuityAmountRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annuity_amount** | **Float** |  | [optional] [default to 1.0]
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**tax_rate** | **Float** |  | [optional] [default to 0.0]
+**account_ids** | **Array<String>** |  | [optional] 
+**initial_balance** | **Float** |  | [optional] [default to 0.0]
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**decumulation_horizon** | **Integer** |  | 
+**accumulation_horizon** | **Integer** |  | 
+**annuity_frequency_interval** | **String** |  | [optional] [default to 'year']
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) |  | [optional] 
+
+

data/docs/AnnuityCalculatorDecumulationHorizonRequest.md

@@ -0,0 +1,19 @@
+# ProtonApi::AnnuityCalculatorDecumulationHorizonRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annuity_amount** | **Float** |  | 
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**tax_rate** | **Float** |  | [optional] [default to 0.0]
+**account_ids** | **Array<String>** |  | [optional] 
+**initial_balance** | **Float** |  | [optional] [default to 0.0]
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**decumulation_horizon** | **Integer** |  | [optional] 
+**accumulation_horizon** | **Integer** |  | 
+**annuity_frequency_interval** | **String** |  | [optional] [default to 'year']
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) |  | [optional] 
+
+

data/docs/AnnuityCalculatorDepositAmountRequest.md

@@ -0,0 +1,19 @@
+# ProtonApi::AnnuityCalculatorDepositAmountRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annuity_amount** | **Float** |  | 
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**tax_rate** | **Float** |  | [optional] [default to 0.0]
+**account_ids** | **Array<String>** |  | [optional] 
+**initial_balance** | **Float** |  | [optional] [default to 0.0]
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**decumulation_horizon** | **Integer** |  | 
+**accumulation_horizon** | **Integer** |  | 
+**annuity_frequency_interval** | **String** |  | [optional] [default to 'year']
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) |  | [optional] 
+
+

data/docs/AnnuityCalculatorInitialBalanceRequest.md

@@ -0,0 +1,19 @@
+# ProtonApi::AnnuityCalculatorInitialBalanceRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annuity_amount** | **Float** |  | 
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**tax_rate** | **Float** |  | [optional] [default to 0.0]
+**account_ids** | **Array<String>** |  | [optional] 
+**initial_balance** | **Float** |  | [optional] [default to 0.0]
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**decumulation_horizon** | **Integer** |  | 
+**accumulation_horizon** | **Integer** |  | 
+**annuity_frequency_interval** | **String** |  | [optional] [default to 'year']
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) |  | [optional] 
+
+

data/docs/AnnuityDepositSchedule.md

@@ -0,0 +1,10 @@
+# ProtonApi::AnnuityDepositSchedule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adjust_deposit_for_inflation** | **BOOLEAN** |  | [optional] [default to true]
+**deposit_frequency_interval** | **String** |  | [optional] [default to 'year']
+**deposit_amount** | **Float** |  | [optional] [default to 0.0]
+
+

data/docs/BacktestRequest.md

@@ -0,0 +1,17 @@
+# ProtonApi::BacktestRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asset_size** | **Float** |  | [optional] 
+**end_date** | **Date** |  | 
+**stats** | **BOOLEAN** |  | [optional] [default to true]
+**asset_sizes** | **BOOLEAN** |  | [optional] [default to true]
+**model_id** | **String** |  | [optional] 
+**initial_weights** | **Object** |  | [optional] 
+**trades** | **BOOLEAN** |  | [optional] [default to true]
+**start_date** | **Date** |  | 
+**settings** | [**Settings**](Settings.md) |  | [optional] 
+**holdings** | **BOOLEAN** |  | [optional] [default to true]
+
+

data/docs/BeneficiaryBequestConfig.md

@@ -0,0 +1,10 @@
+# ProtonApi::BeneficiaryBequestConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bequest_duration** | **Integer** |  | [optional] [default to 10]
+**bequest_amount** | **Float** |  | 
+**years_until_bequest** | **Integer** |  | [optional] [default to 0]
+
+

data/docs/BudgetAggregationAccount.md

@@ -0,0 +1,8 @@
+# ProtonApi::BudgetAggregationAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation_account_id** | **String** |  | 
+
+

data/docs/BudgetCalculatorRequest.md

@@ -0,0 +1,16 @@
+# ProtonApi::BudgetCalculatorRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**as_of_date** | **Date** |  | [optional] 
+**show_budget_track** | **BOOLEAN** |  | [optional] [default to true]
+**budget_id** | **String** |  | [optional] 
+**currency_conversion** | **String** |  | [optional] 
+**lookback_periods** | **Integer** |  | [optional] [default to 1]
+**show_average_spend** | **BOOLEAN** |  | [optional] [default to false]
+**budget_details** | [**BudgetDetails**](BudgetDetails.md) |  | [optional] 
+**relative_lookback** | **BOOLEAN** |  | [optional] [default to true]
+**scope** | **String** |  | [optional] [default to 'all']
+
+

data/docs/BudgetComponent.md

@@ -0,0 +1,10 @@
+# ProtonApi::BudgetComponent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subcategory** | **String** |  | [optional] 
+**category** | **String** |  | 
+**value** | **Float** |  | 
+
+

data/docs/BudgetDetails.md

@@ -0,0 +1,17 @@
+# ProtonApi::BudgetDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**frequency_unit** | **String** |  | 
+**end_date** | **Date** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**budget** | [**Array<BudgetComponent>**](BudgetComponent.md) |  | [optional] 
+**total_value** | **Float** |  | [optional] 
+**account_id** | **String** |  | [optional] 
+**aggregation_accounts** | [**Array<BudgetAggregationAccount>**](BudgetAggregationAccount.md) |  | [optional] 
+**currency_code** | **String** |  | [optional] 
+**frequency** | **Integer** |  | [optional] [default to 1]
+**start_date** | **Date** |  | [optional] 
+
+

data/docs/BusinessFinancialHealthCheckRequest.md

@@ -0,0 +1,22 @@
+# ProtonApi::BusinessFinancialHealthCheckRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**period_length** | **String** |  | [optional] [default to 'quarterly']
+**net_income** | **Float** |  | [optional] 
+**period_month** | **Integer** |  | [optional] 
+**total_revenue** | **Float** |  | [optional] 
+**total_assets** | **Float** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**accounting_method** | **String** |  | [optional] 
+**period_year** | **Integer** |  | [optional] 
+**currency_conversion** | **String** |  | [optional] 
+**total_liabilities** | **Float** |  | [optional] 
+**period_type** | **String** |  | [optional] 
+**currency_code** | **String** |  | [optional] 
+**ratio_targets** | [**RatioTargets1**](RatioTargets1.md) |  | [optional] 
+**total_equity** | **Float** |  | [optional] 
+**period_quarter** | **Integer** |  | [optional] 
+
+

data/docs/BusinessFinancialManagementApi.md

@@ -0,0 +1,288 @@
+# ProtonApi::BusinessFinancialManagementApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**business_financial_health_check**](BusinessFinancialManagementApi.md#business_financial_health_check) | **POST** /business/financial_health_check | Business Financial Health Check
+[**cash_analysis**](BusinessFinancialManagementApi.md#cash_analysis) | **POST** /business/cash_analysis | Cash Analysis
+[**customer_analysis**](BusinessFinancialManagementApi.md#customer_analysis) | **POST** /business/customer_analysis | Customer Analysis
+[**financial_statement_analysis**](BusinessFinancialManagementApi.md#financial_statement_analysis) | **POST** /business/financial_statement_analysis | Financial Statement Analysis
+[**invoice_analysis**](BusinessFinancialManagementApi.md#invoice_analysis) | **POST** /business/invoice_analysis | Invoice Analysis
+
+
+# **business_financial_health_check**
+> Hash<String, Object> business_financial_health_check(business_financial_health_check_request)
+
+Business Financial Health Check
+
+Calculate a series of financial ratios to assess business financial health
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # 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 = ProtonApi::BusinessFinancialManagementApi.new
+
+business_financial_health_check_request = ProtonApi::BusinessFinancialHealthCheckRequest.new # BusinessFinancialHealthCheckRequest | Request payload for Business Financial Health Check
+
+
+begin
+  #Business Financial Health Check
+  result = api_instance.business_financial_health_check(business_financial_health_check_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling BusinessFinancialManagementApi->business_financial_health_check: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **business_financial_health_check_request** | [**BusinessFinancialHealthCheckRequest**](BusinessFinancialHealthCheckRequest.md)| Request payload for Business Financial Health Check | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **cash_analysis**
+> Hash<String, Object> cash_analysis(cash_analysis_request)
+
+Cash Analysis
+
+Analyze cash activity over time
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # 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 = ProtonApi::BusinessFinancialManagementApi.new
+
+cash_analysis_request = ProtonApi::CashAnalysisRequest.new # CashAnalysisRequest | Request payload for Cash Analysis
+
+
+begin
+  #Cash Analysis
+  result = api_instance.cash_analysis(cash_analysis_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling BusinessFinancialManagementApi->cash_analysis: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cash_analysis_request** | [**CashAnalysisRequest**](CashAnalysisRequest.md)| Request payload for Cash Analysis | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **customer_analysis**
+> Hash<String, Object> customer_analysis(customer_analysis_request)
+
+Customer Analysis
+
+Analyze customer revenues over a time period
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # 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 = ProtonApi::BusinessFinancialManagementApi.new
+
+customer_analysis_request = ProtonApi::CustomerAnalysisRequest.new # CustomerAnalysisRequest | Request payload for Customer Analysis
+
+
+begin
+  #Customer Analysis
+  result = api_instance.customer_analysis(customer_analysis_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling BusinessFinancialManagementApi->customer_analysis: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_analysis_request** | [**CustomerAnalysisRequest**](CustomerAnalysisRequest.md)| Request payload for Customer Analysis | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **financial_statement_analysis**
+> Hash<String, Object> financial_statement_analysis(financial_statement_analysis_request)
+
+Financial Statement Analysis
+
+Analyze financial statement accounting data for a business
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # 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 = ProtonApi::BusinessFinancialManagementApi.new
+
+financial_statement_analysis_request = ProtonApi::FinancialStatementAnalysisRequest.new # FinancialStatementAnalysisRequest | Request payload for Financial Statement Analysis
+
+
+begin
+  #Financial Statement Analysis
+  result = api_instance.financial_statement_analysis(financial_statement_analysis_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling BusinessFinancialManagementApi->financial_statement_analysis: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **financial_statement_analysis_request** | [**FinancialStatementAnalysisRequest**](FinancialStatementAnalysisRequest.md)| Request payload for Financial Statement Analysis | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **invoice_analysis**
+> Hash<String, Object> invoice_analysis(invoice_analysis_request)
+
+Invoice Analysis
+
+Analyze invoices to understand the context of money owed and paid to a business
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # 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 = ProtonApi::BusinessFinancialManagementApi.new
+
+invoice_analysis_request = ProtonApi::BusinessInvoiceAnalysisRequest.new # BusinessInvoiceAnalysisRequest | Request payload for Invoice Analysis
+
+
+begin
+  #Invoice Analysis
+  result = api_instance.invoice_analysis(invoice_analysis_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling BusinessFinancialManagementApi->invoice_analysis: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **invoice_analysis_request** | [**BusinessInvoiceAnalysisRequest**](BusinessInvoiceAnalysisRequest.md)| Request payload for Invoice Analysis | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+