proton_api 1.8.0

data/docs/FinancialStatementAnalysisRequest.md

@@ -0,0 +1,22 @@
+# ProtonApi::FinancialStatementAnalysisRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**period_length** | **String** |  | [optional] [default to 'quarterly']
+**period_month** | **Integer** |  | [optional] 
+**end_date** | **Date** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**accounting_method** | **String** |  | 
+**period_year** | **Integer** |  | [optional] 
+**currency_conversion** | **String** |  | [optional] 
+**history_frequency_interval** | **String** |  | [optional] [default to 'month']
+**start_date** | **Date** |  | [optional] 
+**period_type** | **String** |  | [optional] 
+**currency_code** | **String** |  | [optional] 
+**show_history** | **BOOLEAN** |  | [optional] [default to false]
+**stat_names** | **Array<String>** |  | [optional] 
+**period_quarter** | **Integer** |  | [optional] 
+**statement_type** | **String** |  | [optional] [default to 'all']
+
+

data/docs/GoalAccumulationAllocationRequest.md

@@ -0,0 +1,33 @@
+# ProtonApi::GoalAccumulationAllocationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**thresh_type** | **String** |  | [optional] [default to 'perc']
+**goal_id** | **String** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**conf_tgt** | **Float** |  | [optional] [default to 0.9]
+**risk_score** | **Float** |  | [optional] 
+**remove_outliers** | **BOOLEAN** |  | [optional] [default to true]
+**allocation_priority** | **String** |  | 
+**market_data_source** | **String** |  | [optional] [default to 'nucleus']
+**compounding_rate** | **Float** |  | [optional] [default to 0.0]
+**adjust_for_compounding** | **BOOLEAN** |  | [optional] [default to false]
+**opt_config** | [**OptConfig**](OptConfig.md) |  | [optional] 
+**deposit_config** | [**Array<AccumulationGoalDepositConfig>**](AccumulationGoalDepositConfig.md) |  | [optional] 
+**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
+**thresh** | **Float** |  | [optional] 
+**horizon_frequency** | **String** |  | [optional] [default to 'year']
+**recommendation_config** | [**RecommendationConfig**](RecommendationConfig.md) |  | [optional] 
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**withdrawal_tax** | **Float** |  | [optional] [default to 0.0]
+**goal_config** | [**GoalConfig**](GoalConfig.md) |  | [optional] 
+**trading_days_per_year** | **Integer** |  | [optional] [default to 252]
+**allocations** | **Array<String>** |  | [optional] 
+**n** | **Integer** |  | [optional] [default to 1000]
+**horizon** | **Integer** |  | [optional] 
+**recommend_type** | **String** |  | [optional] [default to 'horizon']
+**curr_inv** | **Float** |  | [optional] 
+**allocation_method** | **String** |  | 
+
+

data/docs/GoalAccumulationRecommendationRequest.md

@@ -0,0 +1,28 @@
+# ProtonApi::GoalAccumulationRecommendationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**thresh_type** | **String** |  | [optional] [default to 'perc']
+**goal_id** | **String** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**conf_tgt** | **Float** |  | [optional] [default to 0.9]
+**remove_outliers** | **BOOLEAN** |  | [optional] [default to true]
+**p_ret** | **Array<Float>** |  | 
+**compounding_rate** | **Float** |  | [optional] [default to 0.0]
+**adjust_for_compounding** | **BOOLEAN** |  | [optional] [default to false]
+**deposit_config** | [**Array<AccumulationGoalDepositConfig>**](AccumulationGoalDepositConfig.md) |  | [optional] 
+**thresh** | **Float** |  | [optional] 
+**horizon_frequency** | **String** |  | [optional] [default to 'year']
+**recommendation_config** | [**RecommendationConfig1**](RecommendationConfig1.md) |  | [optional] 
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**withdrawal_tax** | **Float** |  | [optional] [default to 0.0]
+**goal_config** | [**GoalConfig**](GoalConfig.md) |  | [optional] 
+**trading_days_per_year** | **Integer** |  | [optional] [default to 252]
+**n** | **Integer** |  | [optional] [default to 1000]
+**p_risk** | **Array<Float>** |  | 
+**horizon** | **Integer** |  | [optional] 
+**recommend_type** | **String** |  | [optional] [default to 'horizon']
+**curr_inv** | **Float** |  | [optional] 
+
+

data/docs/GoalAccumulationStatusRequest.md

@@ -0,0 +1,28 @@
+# ProtonApi::GoalAccumulationStatusRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**thresh_type** | **String** |  | [optional] [default to 'perc']
+**goal_id** | **String** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**conf_tgt** | **Float** |  | [optional] [default to 0.9]
+**remove_outliers** | **BOOLEAN** |  | [optional] [default to true]
+**p_ret** | **Array<Float>** |  | 
+**compounding_rate** | **Float** |  | [optional] [default to 0.0]
+**adjust_for_compounding** | **BOOLEAN** |  | [optional] [default to false]
+**deposit_config** | [**Array<AccumulationGoalDepositConfig>**](AccumulationGoalDepositConfig.md) |  | [optional] 
+**thresh** | **Float** |  | [optional] 
+**horizon_frequency** | **String** |  | [optional] [default to 'year']
+**recommendation_config** | [**RecommendationConfig**](RecommendationConfig.md) |  | [optional] 
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**withdrawal_tax** | **Float** |  | [optional] [default to 0.0]
+**goal_config** | [**GoalConfig**](GoalConfig.md) |  | [optional] 
+**trading_days_per_year** | **Integer** |  | [optional] [default to 252]
+**n** | **Integer** |  | [optional] [default to 1000]
+**p_risk** | **Array<Float>** |  | 
+**horizon** | **Integer** |  | [optional] 
+**recommend_type** | **String** |  | [optional] [default to 'horizon']
+**curr_inv** | **Float** |  | [optional] 
+
+

data/docs/GoalConfig.md

@@ -0,0 +1,9 @@
+# ProtonApi::GoalConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**goal_inflation** | **Float** |  | [optional] [default to 0.0]
+**goal_amount** | **Float** |  | [optional] 
+
+

data/docs/GoalDecumulationAllocationRequest.md

@@ -0,0 +1,34 @@
+# ProtonApi::GoalDecumulationAllocationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**thresh_type** | **String** |  | [optional] [default to 'perc']
+**goal_id** | **String** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**conf_tgt** | **Float** |  | [optional] [default to 0.9]
+**risk_score** | **Float** |  | [optional] 
+**remove_outliers** | **BOOLEAN** |  | [optional] [default to true]
+**allocation_priority** | **String** |  | 
+**a_horizon** | **Integer** |  | [optional] 
+**withdrawal_config** | [**Array<GoalWithdrawalConfig>**](GoalWithdrawalConfig.md) |  | [optional] 
+**market_data_source** | **String** |  | [optional] [default to 'nucleus']
+**compounding_rate** | **Float** |  | [optional] [default to 0.0]
+**adjust_for_compounding** | **BOOLEAN** |  | [optional] [default to false]
+**opt_config** | [**OptConfig**](OptConfig.md) |  | [optional] 
+**deposit_config** | [**Array<DecumulationGoalDepositConfig>**](DecumulationGoalDepositConfig.md) |  | [optional] 
+**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
+**thresh** | **Float** |  | [optional] 
+**horizon_frequency** | **String** |  | [optional] [default to 'year']
+**recommendation_config** | [**RecommendationConfig**](RecommendationConfig.md) |  | [optional] 
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**withdrawal_tax** | **Float** |  | [optional] [default to 0.0]
+**trading_days_per_year** | **Integer** |  | [optional] [default to 252]
+**allocations** | **Array<String>** |  | [optional] 
+**n** | **Integer** |  | [optional] [default to 1000]
+**d_horizon** | **Integer** |  | [optional] 
+**curr_inv** | **Float** |  | [optional] 
+**recommend_type** | **String** |  | [optional] [default to 'horizon']
+**allocation_method** | **String** |  | 
+
+

data/docs/GoalDecumulationRecommendationRequest.md

@@ -0,0 +1,29 @@
+# ProtonApi::GoalDecumulationRecommendationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**thresh_type** | **String** |  | [optional] [default to 'perc']
+**goal_id** | **String** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**conf_tgt** | **Float** |  | [optional] [default to 0.9]
+**remove_outliers** | **BOOLEAN** |  | [optional] [default to true]
+**a_horizon** | **Integer** |  | [optional] 
+**withdrawal_config** | [**Array<GoalWithdrawalConfig>**](GoalWithdrawalConfig.md) |  | [optional] 
+**p_ret** | **Array<Float>** |  | 
+**compounding_rate** | **Float** |  | [optional] [default to 0.0]
+**adjust_for_compounding** | **BOOLEAN** |  | [optional] [default to false]
+**deposit_config** | [**Array<DecumulationGoalDepositConfig>**](DecumulationGoalDepositConfig.md) |  | [optional] 
+**thresh** | **Float** |  | [optional] 
+**horizon_frequency** | **String** |  | [optional] [default to 'year']
+**recommendation_config** | [**RecommendationConfig1**](RecommendationConfig1.md) |  | [optional] 
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**withdrawal_tax** | **Float** |  | [optional] [default to 0.0]
+**trading_days_per_year** | **Integer** |  | [optional] [default to 252]
+**n** | **Integer** |  | [optional] [default to 1000]
+**d_horizon** | **Integer** |  | [optional] 
+**p_risk** | **Array<Float>** |  | 
+**curr_inv** | **Float** |  | [optional] 
+**recommend_type** | **String** |  | [optional] [default to 'horizon']
+
+

data/docs/GoalDecumulationStatusRequest.md

@@ -0,0 +1,29 @@
+# ProtonApi::GoalDecumulationStatusRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**thresh_type** | **String** |  | [optional] [default to 'perc']
+**goal_id** | **String** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**conf_tgt** | **Float** |  | [optional] [default to 0.9]
+**remove_outliers** | **BOOLEAN** |  | [optional] [default to true]
+**a_horizon** | **Integer** |  | [optional] 
+**withdrawal_config** | [**Array<GoalWithdrawalConfig>**](GoalWithdrawalConfig.md) |  | [optional] 
+**p_ret** | **Array<Float>** |  | 
+**compounding_rate** | **Float** |  | [optional] [default to 0.0]
+**adjust_for_compounding** | **BOOLEAN** |  | [optional] [default to false]
+**deposit_config** | [**Array<DecumulationGoalDepositConfig>**](DecumulationGoalDepositConfig.md) |  | [optional] 
+**thresh** | **Float** |  | [optional] 
+**horizon_frequency** | **String** |  | [optional] [default to 'year']
+**recommendation_config** | [**RecommendationConfig**](RecommendationConfig.md) |  | [optional] 
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**withdrawal_tax** | **Float** |  | [optional] [default to 0.0]
+**trading_days_per_year** | **Integer** |  | [optional] [default to 252]
+**n** | **Integer** |  | [optional] [default to 1000]
+**d_horizon** | **Integer** |  | [optional] 
+**p_risk** | **Array<Float>** |  | 
+**curr_inv** | **Float** |  | [optional] 
+**recommend_type** | **String** |  | [optional] [default to 'horizon']
+
+

data/docs/GoalWithdrawalConfig.md

@@ -0,0 +1,14 @@
+# ProtonApi::GoalWithdrawalConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**with_start_reference** | **String** |  | [optional] [default to 'a_end']
+**with_amount** | **Float** |  | [optional] 
+**with_inflation** | **Float** |  | [optional] [default to 0.0]
+**with_start_period** | **Integer** |  | [optional] [default to 0]
+**with_end_period** | **Integer** |  | [optional] [default to 0]
+**with_end_reference** | **String** |  | [optional] [default to 'd_end']
+**with_frequency** | **String** |  | [optional] [default to 'year']
+
+

data/docs/GoalsApi.md

@@ -0,0 +1,344 @@
+# ProtonApi::GoalsApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**goal_accumulation_allocation**](GoalsApi.md#goal_accumulation_allocation) | **POST** /goal_accumulation/allocation | Goal Accumulation Allocation
+[**goal_accumulation_recommendation**](GoalsApi.md#goal_accumulation_recommendation) | **POST** /goal_accumulation/recommendation | Goal Accumulation Recommendation
+[**goal_accumulation_status**](GoalsApi.md#goal_accumulation_status) | **POST** /goal_accumulation/status | Goal Accumulation Status
+[**goal_decumulation_allocation**](GoalsApi.md#goal_decumulation_allocation) | **POST** /goal_decumulation/allocation | Goal Decumulation Allocation
+[**goal_decumulation_recommendation**](GoalsApi.md#goal_decumulation_recommendation) | **POST** /goal_decumulation/recommendation | Goal Decumulation Recommendation
+[**goal_decumulation_status**](GoalsApi.md#goal_decumulation_status) | **POST** /goal_decumulation/status | Goal Decumulation Status
+
+
+# **goal_accumulation_allocation**
+> Hash<String, Object> goal_accumulation_allocation(goal_accumulation_allocation_request)
+
+Goal Accumulation Allocation
+
+Allocate based on an accumulation goal
+
+### 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::GoalsApi.new
+
+goal_accumulation_allocation_request = ProtonApi::GoalAccumulationAllocationRequest.new # GoalAccumulationAllocationRequest | Request payload for Goal Accumulation Allocation
+
+
+begin
+  #Goal Accumulation Allocation
+  result = api_instance.goal_accumulation_allocation(goal_accumulation_allocation_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling GoalsApi->goal_accumulation_allocation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **goal_accumulation_allocation_request** | [**GoalAccumulationAllocationRequest**](GoalAccumulationAllocationRequest.md)| Request payload for Goal Accumulation Allocation | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **goal_accumulation_recommendation**
+> Hash<String, Object> goal_accumulation_recommendation(goal_accumulation_recommendation_request)
+
+Goal Accumulation Recommendation
+
+Generate recommendations to achieve an accumulation goal
+
+### 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::GoalsApi.new
+
+goal_accumulation_recommendation_request = ProtonApi::GoalAccumulationRecommendationRequest.new # GoalAccumulationRecommendationRequest | Request payload for Goal Accumulation Recommendation
+
+
+begin
+  #Goal Accumulation Recommendation
+  result = api_instance.goal_accumulation_recommendation(goal_accumulation_recommendation_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling GoalsApi->goal_accumulation_recommendation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **goal_accumulation_recommendation_request** | [**GoalAccumulationRecommendationRequest**](GoalAccumulationRecommendationRequest.md)| Request payload for Goal Accumulation Recommendation | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **goal_accumulation_status**
+> Hash<String, Object> goal_accumulation_status(goal_accumulation_status_request)
+
+Goal Accumulation Status
+
+Track the status of an accumulation goal
+
+### 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::GoalsApi.new
+
+goal_accumulation_status_request = ProtonApi::GoalAccumulationStatusRequest.new # GoalAccumulationStatusRequest | Request payload for Goal Accumulation Status
+
+
+begin
+  #Goal Accumulation Status
+  result = api_instance.goal_accumulation_status(goal_accumulation_status_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling GoalsApi->goal_accumulation_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **goal_accumulation_status_request** | [**GoalAccumulationStatusRequest**](GoalAccumulationStatusRequest.md)| Request payload for Goal Accumulation Status | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **goal_decumulation_allocation**
+> Hash<String, Object> goal_decumulation_allocation(goal_decumulation_allocation_request)
+
+Goal Decumulation Allocation
+
+Allocate based on a decumulation goal
+
+### 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::GoalsApi.new
+
+goal_decumulation_allocation_request = ProtonApi::GoalDecumulationAllocationRequest.new # GoalDecumulationAllocationRequest | Request payload for Goal Decumulation Allocation
+
+
+begin
+  #Goal Decumulation Allocation
+  result = api_instance.goal_decumulation_allocation(goal_decumulation_allocation_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling GoalsApi->goal_decumulation_allocation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **goal_decumulation_allocation_request** | [**GoalDecumulationAllocationRequest**](GoalDecumulationAllocationRequest.md)| Request payload for Goal Decumulation Allocation | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **goal_decumulation_recommendation**
+> Hash<String, Object> goal_decumulation_recommendation(goal_decumulation_recommendation_request)
+
+Goal Decumulation Recommendation
+
+Generate recommendations to achieve a decumulation goal
+
+### 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::GoalsApi.new
+
+goal_decumulation_recommendation_request = ProtonApi::GoalDecumulationRecommendationRequest.new # GoalDecumulationRecommendationRequest | Request payload for Goal Decumulation Recommendation
+
+
+begin
+  #Goal Decumulation Recommendation
+  result = api_instance.goal_decumulation_recommendation(goal_decumulation_recommendation_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling GoalsApi->goal_decumulation_recommendation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **goal_decumulation_recommendation_request** | [**GoalDecumulationRecommendationRequest**](GoalDecumulationRecommendationRequest.md)| Request payload for Goal Decumulation Recommendation | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **goal_decumulation_status**
+> Hash<String, Object> goal_decumulation_status(goal_decumulation_status_request)
+
+Goal Decumulation Status
+
+Track the status of a decumulation goal
+
+### 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::GoalsApi.new
+
+goal_decumulation_status_request = ProtonApi::GoalDecumulationStatusRequest.new # GoalDecumulationStatusRequest | Request payload for Goal Decumulation Status
+
+
+begin
+  #Goal Decumulation Status
+  result = api_instance.goal_decumulation_status(goal_decumulation_status_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling GoalsApi->goal_decumulation_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **goal_decumulation_status_request** | [**GoalDecumulationStatusRequest**](GoalDecumulationStatusRequest.md)| Request payload for Goal Decumulation Status | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+