nucleus_api 1.8.0 → 1.9.1

data/docs/VAccountAssetSize.md

@@ -1,11 +0,0 @@
-# NucleusApi::VAccountAssetSize
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account_id** | **String** | account_id | [optional] 
-**asset_size** | **Float** | asset_size | [optional] 
-**cash_flow** | **Float** | cash_flow | [optional] 
-**date** | **Date** |  | [optional] 
-
-

data/docs/VAccountVO.md

@@ -1,13 +0,0 @@
-# NucleusApi::VAccountVO
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account_id** | **String** |  | [optional] 
-**account_name** | **String** |  | [optional] 
-**account_type_id** | **String** |  | [optional] 
-**account_type_name** | **String** |  | [optional] 
-**goal_asset_size_by_account** | **Float** |  | [optional] 
-**goal_asset_size_by_account_date** | **Date** |  | [optional] 
-
-

data/docs/VClientGoalViewData.md

@@ -1,13 +0,0 @@
-# NucleusApi::VClientGoalViewData
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**client_asset_size** | **Float** |  | [optional] 
-**client_asset_size_date** | **Date** |  | [optional] 
-**client_first_name** | **String** |  | [optional] 
-**client_id** | **String** |  | [optional] 
-**client_last_name** | **String** |  | [optional] 
-**client_view_goal_data** | [**Array<ClientViewGoalData>**](ClientViewGoalData.md) |  | [optional] 
-
-

data/docs/VPortfolioVO.md

@@ -1,11 +0,0 @@
-# NucleusApi::VPortfolioVO
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**goal_asset_size_by_portfolio** | **Float** |  | [optional] 
-**goal_asset_size_by_portfolio_date** | **Date** |  | [optional] 
-**portfolio_id** | **String** |  | [optional] 
-**portfolio_name** | **String** |  | [optional] 
-
-

data/docs/Webhook.md

@@ -1,15 +0,0 @@
-# NucleusApi::Webhook
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**atom_service** | **Array<String>** | atom_service | [optional] 
-**create_date** | **DateTime** |  | [optional] 
-**id** | **String** |  | [optional] 
-**is_active** | **BOOLEAN** | isActive | [optional] 
-**secondary_id** | **String** |  | [optional] 
-**secret** | **String** |  | [optional] 
-**update_date** | **DateTime** |  | [optional] 
-**url** | **String** | url | 
-
-

data/docs/WebhookApi.md

@@ -1,309 +0,0 @@
-# NucleusApi::WebhookApi
-
-All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_webhook_using_post**](WebhookApi.md#create_webhook_using_post) | **POST** /webhook | Create a webhook
-[**delete_webhook_using_delete**](WebhookApi.md#delete_webhook_using_delete) | **DELETE** /webhook/{webhook_id} | Delete a webhook
-[**get_webhook_all_using_get**](WebhookApi.md#get_webhook_all_using_get) | **GET** /webhook | List all webhooks
-[**get_webhook_using_get**](WebhookApi.md#get_webhook_using_get) | **GET** /webhook/{webhook_id} | Retrieve a webhook
-[**update_webhook_using_put**](WebhookApi.md#update_webhook_using_put) | **PUT** /webhook/{webhook_id} | Update a webhook
-
-
-# **create_webhook_using_post**
-> Webhook create_webhook_using_post(webhook_request)
-
-Create a webhook
-
-One active webhook service is allowed at all times.
-
-### 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::WebhookApi.new
-
-webhook_request = NucleusApi::Webhook.new # Webhook | webhookRequest
-
-
-begin
-  #Create a webhook
-  result = api_instance.create_webhook_using_post(webhook_request)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling WebhookApi->create_webhook_using_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **webhook_request** | [**Webhook**](Webhook.md)| webhookRequest | 
-
-### Return type
-
-[**Webhook**](Webhook.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: */*
-
-
-
-# **delete_webhook_using_delete**
-> delete_webhook_using_delete(webhook_id)
-
-Delete a webhook
-
-Permanently delete a webhook for your firm. The webhook_id must be provided.
-
-### 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::WebhookApi.new
-
-webhook_id = 'webhook_id_example' # String | UUID webhook_id
-
-
-begin
-  #Delete a webhook
-  api_instance.delete_webhook_using_delete(webhook_id)
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling WebhookApi->delete_webhook_using_delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **webhook_id** | [**String**](.md)| UUID webhook_id | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: */*
-
-
-
-# **get_webhook_all_using_get**
-> PageWebhook get_webhook_all_using_get(opts)
-
-List all webhooks
-
-Get information for all webhooks 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::WebhookApi.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 webhooks
-  result = api_instance.get_webhook_all_using_get(opts)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling WebhookApi->get_webhook_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
-
-[**PageWebhook**](PageWebhook.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: */*
-
-
-
-# **get_webhook_using_get**
-> Webhook get_webhook_using_get(webhook_id)
-
-Retrieve a webhook
-
-Retrieve the information for a specific webhook. The webhook_id must be provided.
-
-### 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::WebhookApi.new
-
-webhook_id = 'webhook_id_example' # String | UUID webhook_id
-
-
-begin
-  #Retrieve a webhook
-  result = api_instance.get_webhook_using_get(webhook_id)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling WebhookApi->get_webhook_using_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **webhook_id** | [**String**](.md)| UUID webhook_id | 
-
-### Return type
-
-[**Webhook**](Webhook.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: */*
-
-
-
-# **update_webhook_using_put**
-> Webhook update_webhook_using_put(webhook, webhook_id)
-
-Update a webhook
-
-Update a webhook for your firm. The webhook_id must be provided
-
-### 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::WebhookApi.new
-
-webhook = nil # Object | webhook
-
-webhook_id = 'webhook_id_example' # String | UUID webhook_id
-
-
-begin
-  #Update a webhook
-  result = api_instance.update_webhook_using_put(webhook, webhook_id)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling WebhookApi->update_webhook_using_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **webhook** | **Object**| webhook | 
- **webhook_id** | [**String**](.md)| UUID webhook_id | 
-
-### Return type
-
-[**Webhook**](Webhook.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: */*
-
-
-

data/lib/nucleus_api/api/application_api.rb

@@ -1,301 +0,0 @@
-=begin
-#Hydrogen Nucleus API
-
-#The Hydrogen Nucleus API
-
-OpenAPI spec version: 1.8.0
-Contact: info@hydrogenplatform.com
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.18
-
-=end
-
-require 'uri'
-
-module NucleusApi
-  class ApplicationApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Create an application
-    # Create an application
-    # @param application application
-    # @param [Hash] opts the optional parameters
-    # @return [Application]
-    def create_application_using_post(application, opts = {})
-      data, _status_code, _headers = create_application_using_post_with_http_info(application, opts)
-      data
-    end
-
-    # Create an application
-    # Create an application
-    # @param application application
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Application, Fixnum, Hash)>] Application data, response status code and response headers
-    def create_application_using_post_with_http_info(application, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ApplicationApi.create_application_using_post ...'
-      end
-      # verify the required parameter 'application' is set
-      if @api_client.config.client_side_validation && application.nil?
-        fail ArgumentError, "Missing the required parameter 'application' when calling ApplicationApi.create_application_using_post"
-      end
-      # resource path
-      local_var_path = '/application'
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(application)
-      auth_names = ['oauth2']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Application')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ApplicationApi#create_application_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Delete an Application
-    # Permanently delete an Application.
-    # @param application_id UUID application_id
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def delete_application_using_delete(application_id, opts = {})
-      delete_application_using_delete_with_http_info(application_id, opts)
-      nil
-    end
-
-    # Delete an Application
-    # Permanently delete an Application.
-    # @param application_id UUID application_id
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def delete_application_using_delete_with_http_info(application_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ApplicationApi.delete_application_using_delete ...'
-      end
-      # verify the required parameter 'application_id' is set
-      if @api_client.config.client_side_validation && application_id.nil?
-        fail ArgumentError, "Missing the required parameter 'application_id' when calling ApplicationApi.delete_application_using_delete"
-      end
-      # resource path
-      local_var_path = '/application/{application_id}'.sub('{' + 'application_id' + '}', application_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['oauth2']
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ApplicationApi#delete_application_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # List all Application
-    # Get details for all Application.
-    # @param [Hash] opts the optional parameters
-    # @option opts [BOOLEAN] :ascending ascending (default to false)
-    # @option opts [String] :filter filter
-    # @option opts [String] :order_by order_by (default to update_date)
-    # @option opts [Integer] :page page (default to 0)
-    # @option opts [Integer] :size size (default to 25)
-    # @return [PageApplication]
-    def get_application_all_using_get(opts = {})
-      data, _status_code, _headers = get_application_all_using_get_with_http_info(opts)
-      data
-    end
-
-    # List all Application
-    # Get details for all Application.
-    # @param [Hash] opts the optional parameters
-    # @option opts [BOOLEAN] :ascending ascending
-    # @option opts [String] :filter filter
-    # @option opts [String] :order_by order_by
-    # @option opts [Integer] :page page
-    # @option opts [Integer] :size size
-    # @return [Array<(PageApplication, Fixnum, Hash)>] PageApplication data, response status code and response headers
-    def get_application_all_using_get_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ApplicationApi.get_application_all_using_get ...'
-      end
-      # resource path
-      local_var_path = '/application'
-
-      # query parameters
-      query_params = {}
-      query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
-      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
-      query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
-      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
-      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['oauth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'PageApplication')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ApplicationApi#get_application_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Retrieve an Application
-    # Retrieve the information for an Application.
-    # @param application_id UUID application_id
-    # @param [Hash] opts the optional parameters
-    # @return [Application]
-    def get_application_using_get(application_id, opts = {})
-      data, _status_code, _headers = get_application_using_get_with_http_info(application_id, opts)
-      data
-    end
-
-    # Retrieve an Application
-    # Retrieve the information for an Application.
-    # @param application_id UUID application_id
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Application, Fixnum, Hash)>] Application data, response status code and response headers
-    def get_application_using_get_with_http_info(application_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ApplicationApi.get_application_using_get ...'
-      end
-      # verify the required parameter 'application_id' is set
-      if @api_client.config.client_side_validation && application_id.nil?
-        fail ArgumentError, "Missing the required parameter 'application_id' when calling ApplicationApi.get_application_using_get"
-      end
-      # resource path
-      local_var_path = '/application/{application_id}'.sub('{' + 'application_id' + '}', application_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['oauth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Application')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ApplicationApi#get_application_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Update an Application
-    # Update the information for an Application
-    # @param application application
-    # @param application_id UUID application_id
-    # @param [Hash] opts the optional parameters
-    # @return [Application]
-    def update_application_using_put(application, application_id, opts = {})
-      data, _status_code, _headers = update_application_using_put_with_http_info(application, application_id, opts)
-      data
-    end
-
-    # Update an Application
-    # Update the information for an Application
-    # @param application application
-    # @param application_id UUID application_id
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Application, Fixnum, Hash)>] Application data, response status code and response headers
-    def update_application_using_put_with_http_info(application, application_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ApplicationApi.update_application_using_put ...'
-      end
-      # verify the required parameter 'application' is set
-      if @api_client.config.client_side_validation && application.nil?
-        fail ArgumentError, "Missing the required parameter 'application' when calling ApplicationApi.update_application_using_put"
-      end
-      # verify the required parameter 'application_id' is set
-      if @api_client.config.client_side_validation && application_id.nil?
-        fail ArgumentError, "Missing the required parameter 'application_id' when calling ApplicationApi.update_application_using_put"
-      end
-      # resource path
-      local_var_path = '/application/{application_id}'.sub('{' + 'application_id' + '}', application_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(application)
-      auth_names = ['oauth2']
-      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Application')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ApplicationApi#update_application_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end