nucleus_api 1.8.0

data/docs/PortfolioAssetSizeLog.md

@@ -0,0 +1,20 @@
+# NucleusApi::PortfolioAssetSizeLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | accountId | 
+**asset_size** | **Float** | asset_size | 
+**asset_size_available** | **Float** | asset_size_available | [optional] 
+**asset_size_pending** | **Float** | asset_size_pending | [optional] 
+**cash_flow** | **Float** | cash_flow | 
+**create_date** | **DateTime** |  | [optional] 
+**currency_code** | **String** | currency_code | [optional] 
+**date** | **DateTime** | date | 
+**id** | **String** |  | [optional] 
+**model_id** | **String** | modelId | 
+**portfolio_id** | **String** | portfolioId | 
+**secondary_id** | **String** |  | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/PortfolioComment.md

@@ -0,0 +1,16 @@
+# NucleusApi::PortfolioComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | accountId | 
+**create_date** | **DateTime** |  | [optional] 
+**id** | **String** |  | [optional] 
+**is_read** | **BOOLEAN** | isRead | [optional] 
+**model_comment_id** | **String** | modelCommentId | 
+**model_id** | **String** | modelId | 
+**portfolio_id** | **String** | portfolioId | 
+**secondary_id** | **String** |  | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/PortfolioGoal.md

@@ -0,0 +1,14 @@
+# NucleusApi::PortfolioGoal
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**create_date** | **DateTime** |  | [optional] 
+**date** | **Date** | date | 
+**goals** | [**Array<PortfolioGoalMap>**](PortfolioGoalMap.md) |  | 
+**id** | **String** |  | [optional] 
+**portfolio_id** | **String** | portfolioId | 
+**secondary_id** | **String** |  | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/PortfolioGoalMap.md

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

data/docs/PortfolioHoldingAgg.md

@@ -0,0 +1,14 @@
+# NucleusApi::PortfolioHoldingAgg
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | amount | [optional] 
+**cost_basis** | **Float** | costBasis | [optional] 
+**currency_code** | **String** | currencyCode | [optional] 
+**date** | **Date** | date | [optional] 
+**security_id** | **String** | securityId | [optional] 
+**shares** | **Float** | shares | [optional] 
+**weight** | **Float** | weight | [optional] 
+
+

data/docs/PortfolioHoldingLog.md

@@ -0,0 +1,21 @@
+# NucleusApi::PortfolioHoldingLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | accountId | 
+**amount** | **Float** | amount | [optional] 
+**cost_basis** | **Float** | cost_basis | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**currency_code** | **String** | currency_code | [optional] 
+**date** | **DateTime** | date | 
+**id** | **String** |  | [optional] 
+**model_id** | **String** | modelId | 
+**portfolio_id** | **String** | portfolioId | 
+**secondary_id** | **String** |  | [optional] 
+**security_id** | **String** | securityId | 
+**shares** | **Float** | shares | 
+**update_date** | **DateTime** |  | [optional] 
+**weight** | **Float** | weight | [optional] 
+
+

data/docs/PortfolioTransaction.md

@@ -0,0 +1,37 @@
+# NucleusApi::PortfolioTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | accountId | 
+**amount** | **Float** | amount | [optional] 
+**balance** | **Float** | balance | [optional] 
+**category** | **String** | category | [optional] 
+**check** | [**Check**](Check.md) |  | [optional] 
+**create_date** | **DateTime** |  | [optional] 
+**currency_code** | **String** | currency_code | [optional] 
+**date** | **DateTime** | date | 
+**date_available** | **DateTime** | dateAvailable | [optional] 
+**description** | **String** | description | [optional] 
+**id** | **String** |  | [optional] 
+**is_cleansed** | **BOOLEAN** | is_cleansed | [optional] 
+**is_disputed** | **BOOLEAN** | is_disputed | [optional] 
+**is_read** | **BOOLEAN** | isRead | [optional] 
+**is_recurring** | **BOOLEAN** | is_recurring | [optional] 
+**location** | [**Location**](Location.md) | location | [optional] 
+**memo** | **String** | memo | [optional] 
+**merchant** | **String** | merchant | [optional] 
+**merchant_category_code** | **Integer** | merchant_category_code | [optional] 
+**metadata** | **Hash<String, String>** | metadata | [optional] 
+**model_id** | **String** | modelId | 
+**portfolio_id** | **String** | portfolioId | 
+**price** | **Float** | price | [optional] 
+**quantity** | **Float** | quantity | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**security_id** | **String** | securityId | [optional] 
+**status** | **String** | status | [optional] 
+**subcategory** | **String** | subcategory | [optional] 
+**transaction_code_id** | **String** | alertId | 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/Question.md

@@ -0,0 +1,23 @@
+# NucleusApi::Question
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**answers** | [**Array<Answer>**](Answer.md) |  | [optional] 
+**category** | **String** | category | [optional] 
+**description** | **String** | description | [optional] 
+**document** | **String** | document | [optional] 
+**id** | **String** |  | [optional] 
+**image** | **String** | image | [optional] 
+**is_account** | **BOOLEAN** | is_account | [optional] 
+**metadata** | **Hash<String, String>** | metadata | [optional] 
+**order_index** | **String** | order_index | [optional] 
+**question_type** | **String** | question_type | [optional] 
+**questionnaire** | [**Questionnaire**](Questionnaire.md) |  | [optional] 
+**questionnaire_id** | **String** | questionnaireId | [optional] 
+**subcategory** | **String** | subcategory | [optional] 
+**title** | **String** | title | [optional] 
+**tooltip** | **String** | tooltip | [optional] 
+**weight** | **Float** | weight | [optional] 
+
+

data/docs/Questionnaire.md

@@ -0,0 +1,17 @@
+# NucleusApi::Questionnaire
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**create_date** | **DateTime** |  | [optional] 
+**decision_tree_id** | **String** | decision_tree_id | [optional] 
+**description** | **String** | description | [optional] 
+**id** | **String** |  | [optional] 
+**is_active** | **BOOLEAN** | is_active | [optional] 
+**name** | **String** | name | 
+**questions** | [**Array<Question>**](Question.md) |  | [optional] 
+**secondary_id** | **String** |  | [optional] 
+**type** | **String** | type | [optional] 
+**update_date** | **DateTime** |  | [optional] 
+
+

data/docs/QuestionnaireApi.md

@@ -0,0 +1,1212 @@
+# NucleusApi::QuestionnaireApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_answer_using_post**](QuestionnaireApi.md#create_answer_using_post) | **POST** /answer | Create an answer
+[**create_client_response_using_post**](QuestionnaireApi.md#create_client_response_using_post) | **POST** /client_response | Create a client response
+[**create_question_using_post**](QuestionnaireApi.md#create_question_using_post) | **POST** /question | Create a question
+[**create_questionnaire_using_post**](QuestionnaireApi.md#create_questionnaire_using_post) | **POST** /questionnaire | Create a questionnaire
+[**delete_answer_using_delete**](QuestionnaireApi.md#delete_answer_using_delete) | **DELETE** /answer/{answer_id} | Delete an answer
+[**delete_client_response_using_delete**](QuestionnaireApi.md#delete_client_response_using_delete) | **DELETE** /client_response/{client_response_id} | Delete a client response
+[**delete_question_using_delete**](QuestionnaireApi.md#delete_question_using_delete) | **DELETE** /question/{question_id} | Delete a question
+[**delete_questionnaire_using_delete**](QuestionnaireApi.md#delete_questionnaire_using_delete) | **DELETE** /questionnaire/{questionnaire_id} | Delete a questionnaire
+[**get_answer_all_using_get**](QuestionnaireApi.md#get_answer_all_using_get) | **GET** /answer | List all Answers
+[**get_answer_using_get**](QuestionnaireApi.md#get_answer_using_get) | **GET** /answer/{answer_id} | Retrieve an answer
+[**get_client_response_all_using_get**](QuestionnaireApi.md#get_client_response_all_using_get) | **GET** /client_response | List all client responses
+[**get_client_response_using_get**](QuestionnaireApi.md#get_client_response_using_get) | **GET** /client_response/{client_response_id} | Retrieve a client response
+[**get_question_all_using_get**](QuestionnaireApi.md#get_question_all_using_get) | **GET** /question | List all Questions
+[**get_question_using_get**](QuestionnaireApi.md#get_question_using_get) | **GET** /question/{question_id} | Retrieve a question
+[**get_questionnaire_all_using_get**](QuestionnaireApi.md#get_questionnaire_all_using_get) | **GET** /questionnaire | List all questionnaires
+[**get_questionnaire_using_get**](QuestionnaireApi.md#get_questionnaire_using_get) | **GET** /questionnaire/{questionnaire_id} | Retrieve a questionnaire
+[**update_answer_using_put**](QuestionnaireApi.md#update_answer_using_put) | **PUT** /answer/{answer_id} | Update an answer
+[**update_client_response_using_put**](QuestionnaireApi.md#update_client_response_using_put) | **PUT** /client_response/{client_response_id} | Update a client response
+[**update_question_using_put**](QuestionnaireApi.md#update_question_using_put) | **PUT** /question/{question_id} | Update a question.
+[**update_questionnaire_using_put**](QuestionnaireApi.md#update_questionnaire_using_put) | **PUT** /questionnaire/{questionnaire_id} | Update a questionnaire
+
+
+# **create_answer_using_post**
+> Answer create_answer_using_post(answer)
+
+Create an answer
+
+Create a new answer for question.
+
+### 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::QuestionnaireApi.new
+
+answer = NucleusApi::Answer.new # Answer | answer
+
+
+begin
+  #Create an answer
+  result = api_instance.create_answer_using_post(answer)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->create_answer_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **answer** | [**Answer**](Answer.md)| answer | 
+
+### Return type
+
+[**Answer**](Answer.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_client_response_using_post**
+> ClientResponse create_client_response_using_post(client_response)
+
+Create a client response
+
+Create a new client response for a question as part of a questionnaires.
+
+### 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::QuestionnaireApi.new
+
+client_response = NucleusApi::ClientResponse.new # ClientResponse | clientResponse
+
+
+begin
+  #Create a client response
+  result = api_instance.create_client_response_using_post(client_response)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->create_client_response_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_response** | [**ClientResponse**](ClientResponse.md)| clientResponse | 
+
+### Return type
+
+[**ClientResponse**](ClientResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **create_question_using_post**
+> Question create_question_using_post(question)
+
+Create a question
+
+Create a new question for questionnaire.
+
+### 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::QuestionnaireApi.new
+
+question = NucleusApi::Question.new # Question | question
+
+
+begin
+  #Create a question
+  result = api_instance.create_question_using_post(question)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->create_question_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **question** | [**Question**](Question.md)| question | 
+
+### Return type
+
+[**Question**](Question.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_questionnaire_using_post**
+> Questionnaire create_questionnaire_using_post(questionnaire)
+
+Create a questionnaire
+
+Create a new questionnaire 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::QuestionnaireApi.new
+
+questionnaire = NucleusApi::Questionnaire.new # Questionnaire | questionnaire
+
+
+begin
+  #Create a questionnaire
+  result = api_instance.create_questionnaire_using_post(questionnaire)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->create_questionnaire_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **questionnaire** | [**Questionnaire**](Questionnaire.md)| questionnaire | 
+
+### Return type
+
+[**Questionnaire**](Questionnaire.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete_answer_using_delete**
+> delete_answer_using_delete(answer_id)
+
+Delete an answer
+
+Delete an answer for the question
+
+### 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::QuestionnaireApi.new
+
+answer_id = 'answer_id_example' # String | UUID answer_id
+
+
+begin
+  #Delete an answer
+  api_instance.delete_answer_using_delete(answer_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->delete_answer_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **answer_id** | [**String**](.md)| UUID answer_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_client_response_using_delete**
+> delete_client_response_using_delete(client_response_id)
+
+Delete a client response
+
+Permanently delete a client response 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::QuestionnaireApi.new
+
+client_response_id = 'client_response_id_example' # String | UUID client_response_id
+
+
+begin
+  #Delete a client response
+  api_instance.delete_client_response_using_delete(client_response_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->delete_client_response_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_response_id** | [**String**](.md)| UUID client_response_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_question_using_delete**
+> delete_question_using_delete(question_id)
+
+Delete a question
+
+Delete an answer for the question
+
+### 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::QuestionnaireApi.new
+
+question_id = 'question_id_example' # String | UUID question_id
+
+
+begin
+  #Delete a question
+  api_instance.delete_question_using_delete(question_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->delete_question_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **question_id** | [**String**](.md)| UUID question_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **delete_questionnaire_using_delete**
+> delete_questionnaire_using_delete(questionnaire_id)
+
+Delete a questionnaire
+
+Permanently delete a questionnaire 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::QuestionnaireApi.new
+
+questionnaire_id = 'questionnaire_id_example' # String | UUID questionnaire_id
+
+
+begin
+  #Delete a questionnaire
+  api_instance.delete_questionnaire_using_delete(questionnaire_id)
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->delete_questionnaire_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **questionnaire_id** | [**String**](.md)| UUID questionnaire_id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_answer_all_using_get**
+> PageAnswer get_answer_all_using_get(opts)
+
+List all Answers
+
+Get information for all Answers
+
+### 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::QuestionnaireApi.new
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  filter: 'filter_example', # String | filter
+  order_by: 'label', # String | order_by
+  page: 0, # Integer | page
+  size: 25 # Integer | size
+}
+
+begin
+  #List all Answers
+  result = api_instance.get_answer_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->get_answer_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 label]
+ **page** | **Integer**| page | [optional] [default to 0]
+ **size** | **Integer**| size | [optional] [default to 25]
+
+### Return type
+
+[**PageAnswer**](PageAnswer.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_answer_using_get**
+> Answer get_answer_using_get(answer_id)
+
+Retrieve an answer
+
+Retrieve the information for an answer for question
+
+### 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::QuestionnaireApi.new
+
+answer_id = 'answer_id_example' # String | UUID answer_id
+
+
+begin
+  #Retrieve an answer
+  result = api_instance.get_answer_using_get(answer_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->get_answer_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **answer_id** | [**String**](.md)| UUID answer_id | 
+
+### Return type
+
+[**Answer**](Answer.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_client_response_all_using_get**
+> PageClientResponse get_client_response_all_using_get(opts)
+
+List all client responses
+
+Get all the client responses for questions as part of a questionnaire defined by 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::QuestionnaireApi.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 responses
+  result = api_instance.get_client_response_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->get_client_response_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
+
+[**PageClientResponse**](PageClientResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_client_response_using_get**
+> ClientResponse get_client_response_using_get(client_response_id)
+
+Retrieve a client response
+
+Retrieve the information for a client response 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::QuestionnaireApi.new
+
+client_response_id = 'client_response_id_example' # String | UUID client_response_id
+
+
+begin
+  #Retrieve a client response
+  result = api_instance.get_client_response_using_get(client_response_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->get_client_response_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_response_id** | [**String**](.md)| UUID client_response_id | 
+
+### Return type
+
+[**ClientResponse**](ClientResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_question_all_using_get**
+> PageQuestion get_question_all_using_get(opts)
+
+List all Questions
+
+Get information for all Questions
+
+### 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::QuestionnaireApi.new
+
+opts = { 
+  ascending: false, # BOOLEAN | ascending
+  filter: 'filter_example', # String | filter
+  order_by: 'order_index', # String | order_by
+  page: 0, # Integer | page
+  size: 25 # Integer | size
+}
+
+begin
+  #List all Questions
+  result = api_instance.get_question_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->get_question_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 order_index]
+ **page** | **Integer**| page | [optional] [default to 0]
+ **size** | **Integer**| size | [optional] [default to 25]
+
+### Return type
+
+[**PageQuestion**](PageQuestion.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_question_using_get**
+> Question get_question_using_get(question_id)
+
+Retrieve a question
+
+Retrieve the information for a question for questionnaire
+
+### 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::QuestionnaireApi.new
+
+question_id = 'question_id_example' # String | UUID question_id
+
+
+begin
+  #Retrieve a question
+  result = api_instance.get_question_using_get(question_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->get_question_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **question_id** | [**String**](.md)| UUID question_id | 
+
+### Return type
+
+[**Question**](Question.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_questionnaire_all_using_get**
+> PageQuestionnaire get_questionnaire_all_using_get(opts)
+
+List all questionnaires
+
+Get the information for all questionnaires 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::QuestionnaireApi.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 questionnaires
+  result = api_instance.get_questionnaire_all_using_get(opts)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->get_questionnaire_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
+
+[**PageQuestionnaire**](PageQuestionnaire.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get_questionnaire_using_get**
+> Questionnaire get_questionnaire_using_get(questionnaire_id)
+
+Retrieve a questionnaire
+
+Retrieve the information for a questionnaire 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::QuestionnaireApi.new
+
+questionnaire_id = 'questionnaire_id_example' # String | UUID questionnaire_id
+
+
+begin
+  #Retrieve a questionnaire
+  result = api_instance.get_questionnaire_using_get(questionnaire_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->get_questionnaire_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **questionnaire_id** | [**String**](.md)| UUID questionnaire_id | 
+
+### Return type
+
+[**Questionnaire**](Questionnaire.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update_answer_using_put**
+> Answer update_answer_using_put(answer, answer_id)
+
+Update an answer
+
+Update a answer for question.
+
+### 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::QuestionnaireApi.new
+
+answer = nil # Object | answer
+
+answer_id = 'answer_id_example' # String | UUID answer_id
+
+
+begin
+  #Update an answer
+  result = api_instance.update_answer_using_put(answer, answer_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->update_answer_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **answer** | **Object**| answer | 
+ **answer_id** | [**String**](.md)| UUID answer_id | 
+
+### Return type
+
+[**Answer**](Answer.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_client_response_using_put**
+> ClientResponse update_client_response_using_put(client_response, client_response_id)
+
+Update a client response
+
+Update a client response 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::QuestionnaireApi.new
+
+client_response = nil # Object | client_response
+
+client_response_id = 'client_response_id_example' # String | UUID client_response_id
+
+
+begin
+  #Update a client response
+  result = api_instance.update_client_response_using_put(client_response, client_response_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->update_client_response_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_response** | **Object**| client_response | 
+ **client_response_id** | [**String**](.md)| UUID client_response_id | 
+
+### Return type
+
+[**ClientResponse**](ClientResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_question_using_put**
+> Question update_question_using_put(question, question_id)
+
+Update a question.
+
+Update a question for questionnaire.
+
+### 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::QuestionnaireApi.new
+
+question = nil # Object | question
+
+question_id = 'question_id_example' # String | UUID question_id
+
+
+begin
+  #Update a question.
+  result = api_instance.update_question_using_put(question, question_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->update_question_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **question** | **Object**| question | 
+ **question_id** | [**String**](.md)| UUID question_id | 
+
+### Return type
+
+[**Question**](Question.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **update_questionnaire_using_put**
+> Questionnaire update_questionnaire_using_put(questionnaire, questionnaire_id)
+
+Update a questionnaire
+
+Update a questionnaire 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::QuestionnaireApi.new
+
+questionnaire = nil # Object | questionnaire
+
+questionnaire_id = 'questionnaire_id_example' # String | UUID questionnaire_id
+
+
+begin
+  #Update a questionnaire
+  result = api_instance.update_questionnaire_using_put(questionnaire, questionnaire_id)
+  p result
+rescue NucleusApi::ApiError => e
+  puts "Exception when calling QuestionnaireApi->update_questionnaire_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **questionnaire** | **Object**| questionnaire | 
+ **questionnaire_id** | [**String**](.md)| UUID questionnaire_id | 
+
+### Return type
+
+[**Questionnaire**](Questionnaire.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+